Skip to content

Commit

Permalink
Merge pull request #5154 from EnterpriseDB/content/docs/biganimal/thi…
Browse files Browse the repository at this point in the history
…rd-party-integrations

BigAnimal - Third-party integrations as per UPM-27644
  • Loading branch information
nidhibhammar authored Jan 30, 2024
2 parents f89d04c + 08b7440 commit 13c86d2
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "Datadog"
---

Datadog integration is based on the OpenTelemetry Collector and the Datadog plugin bundled with the OpenTelemetry collector. Once enabled, BigAnimal automatically configures data planes to send the Telemetry to your Datadog account via Datadog's cloud receive endpoint.

## Pre-requisites

A pre-existing Datadog account is required to use this integration.

## Enabling Datadog

To enable the **Datadog** integrations:

1. Select an existing project from the **Projects** page.
2. Go to **Settings** on the left-side navigation.
3. Select **Integrations** from the **Settings** drop down list.
4. Select **Datadog**, a window pops-up to provide the details:
- **Datadog API Key** — Provide an API Key. For more details, see [Datadog API Key](https://docs.datadoghq.com/account_management/api-app-keys/). The API Key is sensitive and can't be retrieved once saved.
- **Datadog Site Name** — Provide the Datadog site name by selecting from the available options in the drop-down list. The telemetry goes to this chosen Datadog site.
- **Datadog Site URL** — The Datadog site URL gets selected automatically based on the Datadog site name you selected.
- **Datadog API Key ID** — Provide the API Key ID, that acts as the name to store an identifier for the key. This identifier is used for future reference to check the configuration details.

Provide all the details and then select **Save**.

Once you enable this integration, it sends BigAnimal telemetry to your Datadog account.

!!! note "Important"
Generate a new API Key in Datadog to enable this integration in BigAnimal. This API key must be specific to this integration and shouldn't be shared. Whenever you disable this integration, revoke the API Key using the Datadog UI. Once revoked, it disables the Datadog ingestion and billable usage from the BigAnimal integration. This doesn't impact the other services using the Datadog API.
!!!

## Metrics

BigAnimal sends a subset of the OpenTelemetry Collector's metrics from the hostmetrics and kubeletstats receivers, plus BigAnimal custom metrics for the monitored Postgres instance.

You can see a list of metrics in the Datadog user interface, along with the tags for each metric.

To see the list of metrics, go to **Metrics > Summary**. Then select a specific metric to see the tags for that metric.

The set of metrics delivered to DataDog is subject to change. Metrics with names that begin with `postgres.preview.` or `biganimal.preview.` are likely to be renamed or removed in a future release. Other metrics may also be renamed, added, or removed to better integrate into the DataDog platform.

## Cost

After enabling the BigAnimal telemetry integration, check your billable Datadog usage and continue to monitor it over time.

Be aware of the following cost considerations:

* *You are responsible for all costs* charged to your Datadog account by telemetry sent by the BigAnimal Datadog integration. Charges are based on usage but they could even result from BigAnimal errors or oversights. If you do not accept this responsibility, do not enable the Datadog integration.
* Datadog bills for each monitored Postgres node (including any replicas) as a "monitored host" in the your Datadog plan. See the [Datadog price list](https://www.datadoghq.com/pricing/list/) for current pricing per monitored host.
* Datadog *may* bill for each Postgres container and monitoring agent container running on each monitored Postgres node. See the [Datadog price list](https://www.datadoghq.com/pricing/list/) for current pricing per monitored container.
* Datadog counts some of the metrics sent by BigAnimal as custom metrics. Datadog plans include a limited number of free unique custom metrics dimensions per host. Additional metrics dimensions above the free limit are billable at a rate set in the Datadog price list. See your [Datadog plan price list](https://www.datadoghq.com/pricing/list/) for details. Although BigAnimal's telemetry integration for Datadog tries to limit custom metrics delivery to minimize additional billable Datadog usage, you should still expect some billable custom metrics usage.

To disable the Datadog integration for BigAnimal and ensure no further costs are incurred on your Datadog account, you must revoke the API key provided to BigAnimal. Disabling the integration on the BigAnimal Portal is not sufficient.

Currently, Datadog does not offer any mechanism for configuring a usage limit or billing cap for monitored hosts, monitored containers, or custom metrics. The Datadog [metrics without limits feature](https://docs.datadoghq.com/metrics/metrics-without-limits/) can limit cardinality-based billing for custom metrics, but it enables ingestion-based billing instead, so the overall price may actually be greater. You must actively monitor and be alert to your Datadog usage-based billing using the Datadog-provided [usage metrics](https://docs.datadoghq.com/account_management/billing/usage_metrics/), such as `datadog.estimated_usage.hosts`, `datadog.estimated_usage.containers`, and `datadog.estimated_usage.metrics.custom`.

For more information, see also:
- [Datadog pricing list](https://www.datadoghq.com/pricing/list/)
- [Custom metrics billing](https://docs.datadoghq.com/account_management/billing/custom_metrics/?tab=countrate#counting-custom-metrics)
- [Usage metrics billing](https://docs.datadoghq.com/account_management/billing/usage_metrics/)
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Third party monitoring integrations"
---

BigAnimal provides support for third-party monitoring integrations for both using your own account and BigAnimal's cloud account.

Monitoring integrations are configured at project level in BigAnimal. It can't be turned on or off for the individual clusters. An Org admin or a Project owner can set up an integration. Only one integration can be set up per project.

By default, all the integrations are disabled. Enable it using the **Integrations** tab after creating the project.

All the metrics collected from all the clusters in the Project are sent to the integrated tool and are displayed in BigAnimal's [**Monitoring and logging** tab using PEMx](../monitoring_using_pemx). The collected logs are exported to the object storage by default.

The third-party integrations available in BigAnimal are:

- [Datadog](./datadog)
- [New Relic](./newrelic)
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "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.

## Pre-requisites

A pre-existing New Relic account is required to use this integration.

## Enable New Relic

To enable the **New Relic** integration:
1. Select an existing project from the **Projects** page.
2. Go to **Settings** on the left-side navigation.
3. Select **Integrations** from the **Settings** drop down list.
4. Select **New Relic**, a window pops up to provide the details:
- **New Relic API key** - Provide an API Key. For more details, see [New Relic API Key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/). The API Key is sensitive and can't be retrieved once saved.
- **New Relic API Key Name** - Provide the API Key name to store an identifier for the key. This identifier is used for future reference to check the configuration details.
- **New Relic Account ID** - Provide the account ID of New Relic.

Provide all the details and select **Save**.

Once you enable this integration, it sends BigAnimal telemetry to your New Relic account.

!!! note "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 and shouldn't be shared. Whenever you disable this integration, revoke the API Key using the New Relic UI. Once revoked, it disables the New Relic ingestion and billable usage from the BigAnimal integration. This doesn't impact the other services using the New Relic API.
!!!

## Metrics

BigAnimal sends a subset of the OpenTelemetry Collector's metrics from the hostmetrics and kubeletstats receivers, plus BigAnimal custom metrics for the monitored Postgres instance.

You can see a list of metrics in the New Relic user interface, along with dimensions for each metric.

To see a list of metrics, go to **Metrics & Events**. Then select a specific 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.` may be renamed or removed in a future release. Other metrics may 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 could even result from BigAnimal errors or oversights. If you do not accept this responsibility, do not enable the New Relic integration.

* 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. Customers should review their limits before enabling the BigAnimal integration. In the New Relic user interface, see **Administration > Data management > Limits**. Also refer to the following related topics in the New Relic documentation:

* [Understand and manage data ingest](https://docs.newrelic.com/docs/data-apis/manage-data/manage-data-coming-new-relic/)
* [Data ingest: Billing and rules](https://docs.newrelic.com/docs/accounts/accounts-billing/new-relic-one-pricing-billing/data-ingest-billing/)
* [Understand New Relic data limits](https://docs.newrelic.com/docs/data-apis/manage-data/view-system-limits/)
* [Get more detail about your data limits](https://docs.newrelic.com/docs/data-apis/manage-data/query-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 is not sufficient.

1 comment on commit 13c86d2

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.