This repo contains some common code that was originally used in multiple repositories used by the Logging Integrations team. (refer to the originals for git history)
We've extracted it so we can keep updates synchronized. We've also added some documentation to make it easier to use.
This is a standard npm package and can be directly npm installed.
This library exports several modules. Here's how to use them
This function is used to require an environment variable and throws if it is not set
const VAR_1 = requireEnvironmentVariable('ENV_VAR_1');This module provides functionality that allows one to check for Logs using an NRDB query. The nrdb object must be constructed using an Account object.
The following query functions accept a QueryOptions object
Returns a promise that resolves to a log event recieved from NRDB.
Returns a promise that resolves to an array that contains all the matching events recieved from NRDB.
Used when constructing nrdb
| Name | Type | Description | Required? | Default |
|---|---|---|---|---|
| accountId | number | the account ID | Yes | - |
| apiKey | string | the value to put in the Api-Key header on queries | Yes | - |
| nerdGraphUrl | string | the URL of the NerdGraph API in the environment | Yes | - |
Used when querying events using one of the Nrdb.find* methods
| Name | Type | Description | Required? | Default |
|---|---|---|---|---|
| select | string | What to select | No | * |
| from | string | What event type to query | No | Log |
| where | string | What to put in a WHERE clause |
No | (none) |
| limit | number | What to put for a LIMIT |
No | 2000 |
| wait | number | Time (in milliseconds) to wait for events to show up in NRDB | No | WAIT_FOR_PROCESSING |
| since | number | What to put for SINCE |
No | 5 minutes ago |
| until | number | What to put for UNTIL |
No | (none) |
| didNotFindAllResultsMessage | function(foundResults: array, expectedResultCount: number): string | What message to output when the query fails to find all results | No | (a sensible error message) |
This module provides a winston logger in a standardized format.
This module provides some utility functions used in tests. Check the individual functions for explanations
Accepts milliseconds, returns a promise.
await sleep(1000); // waits for 1 secondReturns the current time in the form of an ISO string
We encourage your contributions to improve [project name]! Keep in mind when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project. If you have any questions, or to execute our corporate CLA, required if your contribution is on behalf of a company, please drop us an email at [email protected].
A note about vulnerabilities
As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.
If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through HackerOne.
Logging Integrations Testing Library is licensed under the Apache 2.0 License.