New Relic
The New Relic integration is based on the OpenTelemetry Collector, shipping the metrics over the standard OLTP protocol to the New Relic cloud endpoint.
Note
New Relic integration doesn't install the New Relic agent. It sends telemetry to the New Relic API.
Prerequisites
You need a New Relic account before you can use this integration.
Enable New Relic
To enable the New Relic integration:
- From the Projects page, select an existing project.
- Go to Settings on the left-side navigation.
- From the Settings list, select Integrations .
- Select New Relic. In the window, provide the details:
- New Relic API Key — For details, see New Relic API Key. The API key is sensitive information. You can't retrieve it after you save it.
- New Relic API Key Name — Assign a name for the API key. You can use the API Key ID name to check the configuration details.
- New Relic Account ID — Provide the New Relic account ID.
- Select Save.
Enabling this integration sends BigAnimal telemetry to your New Relic account.
Important
Generate a new API license key in New Relic to enable this integration in BigAnimal. This API key must be specific to this integration. Don't share the key. Whenever you disable this integration, revoke the API key using the New Relic interface. Revoking the key disables the New Relic ingestion and billable usage from the BigAnimal integration. Revoking the key doesn't impact the other services that use the New Relic API.
Metrics
BigAnimal sends a subset of the OpenTelemetry Collector's metrics from the hostmetrics and kubeletstats receivers. It also sends BigAnimal custom metrics for the monitored Postgres instance.
You can see a list of metrics in the New Relic interface along with dimensions for each metric.
To see a list of metrics, select Metrics & Events. Then select a metric to see the dimensions sent for that metric.
The set of metrics delivered to New Relic is subject to change. Metrics with names that begin with postgres.preview. or biganimal.preview. might be renamed or removed in a future release. Other metrics might also be renamed, added, or removed to better integrate into the New Relic platform.
Cost
After enabling the BigAnimal telemetry integration, check your billable New Relic usage and continue to monitor it over time.
Be aware of the following important cost considerations:
You are responsible for all costs charged to your New Relic account by telemetry sent by the BigAnimal New Relic integration. Charges are based on usage, but they can also result from BigAnimal errors or oversights. Enable the New Relic integration only if you accept this responsibility.
New Relic bills usage by bytes ingested and for data retention. You must monitor and configure alerts on your New Relic data ingestion to reduce the risk of unexpectedly large usage bills. Also check your retention settings.
New Relic has features to limit usage and ingestion. Review your limits before enabling the BigAnimal integration. In New Relic, select Administration > Data management > Limits. Also see the following related topics in the New Relic documentation:
- Understand and manage data ingest
- Data ingest: Billing and rules
- Understand New Relic data limits
- Get more detail about your data limits
To disable the New Relic integration for BigAnimal and ensure no further costs are incurred on your New Relic account, you must revoke the API key provided to BigAnimal. Disabling the integration on the BigAnimal portal doesn't prevent costs from being incurred.
- On this page
- Prerequisites
- Enable New Relic
- Metrics
- Cost