Skip to content

Commit

Permalink
[doc][ybm] Prometheus integration (#23292)
Browse files Browse the repository at this point in the history
* Prometheus integration

* edits

* DOC-415

* review comment

* review comments

* Update docs/content/preview/yugabyte-cloud/cloud-monitor/managed-integrations.md
  • Loading branch information
ddhodge authored Aug 8, 2024
1 parent 78a2bc7 commit da9b281
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/vale-styles/Yugabyte/spelling-exceptions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ chatbots
ChatOps
checksummed
checksumming
CIDRs
Citrix
Citus
clonable
Expand Down Expand Up @@ -691,6 +692,7 @@ syscall
syscalls
syslog
systemd
tabpane
tablegroup
tablegroups
tablespace
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Each region in multi-region clusters must be deployed in a VPC. Depending on the

| Provider | Regional VPC setup |
| :--- | :--- |
| AWS | You need to create a VPC in each region where the cluster is to be deployed.<br/>To deploy a multi-region cluster into those regional VPCs, ensure that the CIDRs of the VPCs do not overlap.<br/>If you intend to peer different VPCs to the same application VPC, ensure that the CIDRs of the VPCs do not overlap. |
| AWS | You need to create a VPC in each region where the cluster is to be deployed.<br/>To deploy a multi-region cluster into those regional VPCs, ensure that the CIDRs of the VPCs do not overlap.<br/>If you intend to peer different VPCs to the same application VPC, ensure that the CIDRs of the VPCs do not overlap. See [Restrictions](#restrictions). |
| Azure | You need to create a VPC in each region where the cluster is to be deployed.<br/>Azure assigns the CIDR automatically. |
| GCP Custom region selection | When creating the VPC, you provide network blocks for each region where you intend to deploy the cluster; each region of the cluster is deployed in the same VPC.<br/>If you plan to expand your cluster into new regions in the future, add those regions to the VPC when you create the VPC; _you can not expand into new regions after the VPC is created_. |
| GCP Automated region selection | Create a single global VPC and let GCP assign network blocks to every region; each region of the cluster is deployed in the same VPC.<br/>GCP does not recommend auto mode VPC networks for production; refer to [Considerations for auto mode VPC networks](https://cloud.google.com/vpc/docs/vpc#auto-mode-considerations). |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ To create an interface endpoint to connect to your cluster PSE, do the following
![AWS Create endpoint](/images/yb-cloud/managed-endpoint-aws-2.png)
Make sure the security groups in your application VPC allow internal connectivity. Otherwise, your application may not be able to reach the endpoint.
1. Click **Create endpoint**.
The endpoint is added to the Endpoints in AWS.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Currently, you can export data to the following tools:
- [Datadog](https://docs.datadoghq.com/)
- [Grafana Cloud](https://grafana.com/docs/grafana-cloud/)
- [Sumo Logic](https://www.sumologic.com)
- [Prometheus](https://prometheus.io/docs/introduction/overview/) {{<badge/tp>}}

Exporting cluster metrics and logs counts against your data transfer allowance. This may incur additional costs for network transfer, especially for cross-region and internet-based transfers, if usage exceeds your cluster allowance. Refer to [Data transfer costs](../../cloud-admin/cloud-billing-costs/#data-transfer-costs).

Expand Down Expand Up @@ -95,6 +96,37 @@ To create an export configuration, do the following:
1. Enter your installation token, access ID, and access key.
1. Optionally, click **Download** to download the Sumo Logic dashboard template. After you install the [YugabyteDB app](https://help.sumologic.com/docs/get-started/apps-integrations/) (coming soon) in your Sumo Logic account, you can import this JSON format template and use it as a starting point for visualizing your cluster data.
1. Click **Test Configuration** to make sure your connection is working.
1. Click **Create Configuration**.

{{% /tab %}}

{{% tab header="Prometheus" lang="prometheus" %}}

Prometheus integration is {{<badge/tp>}} and only available for clusters deployed on AWS.

The Prometheus integration requires the following:

- Prometheus instance
- deployed in a VPC on AWS
- [OLTP Receiver](https://prometheus.io/docs/prometheus/latest/querying/api/#otlp-receiver) feature flag enabled
- publically-accessible endpoint URL that resolves to the private IP of the Prometheus instance; the DNS for the endpoint must be in a public hosted zone in AWS.
- VPC hosting the Prometheus instance has the following Inbound Security Group rules:
- Allow HTTP inbound traffic on port 80 for Prometheus endpoint URL (HTTP)
- Allow HTTPS inbound traffic on port 443 for Prometheus endpoint URL (HTTPS)

See [Control traffic to your AWS resources using security groups](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html) in the AWS documentation.

- YugabyteDB Aeon cluster from which you want to export metrics
- the cluster is [deployed in VPCs](../../cloud-basics/cloud-vpcs/cloud-add-vpc/) on AWS
- each region VPC is peered with the VPC hosting Prometheus. See [Peer VPCs](../../cloud-basics/cloud-vpcs/cloud-add-vpc-aws/).

As each region of a cluster deployed in AWS has its own VPC, make sure that all the VPCs are peered and allow inbound access from Prometheus; this also applies to regions you add or change after deployment, and to read replicas. For information on VPC networking in YugabyteDB Aeon, see [VPC network overview](../../cloud-basics/cloud-vpcs/cloud-vpc-intro/).

To create an export configuration, do the following:

1. On the **Integrations** page, click **Configure** for the Prometheus provider or, if a configuration is already available, **Add Configuration**.
1. Enter a name for the configuration.
1. Enter the endpoint URL of the Prometheus instance.
1. Click **Create Configuration**.

{{% /tab %}}
Expand Down

0 comments on commit da9b281

Please sign in to comment.