Skip to content

Commit da9b281

Browse files
authored
[doc][ybm] Prometheus integration (yugabyte#23292)
* Prometheus integration * edits * DOC-415 * review comment * review comments * Update docs/content/preview/yugabyte-cloud/cloud-monitor/managed-integrations.md
1 parent 78a2bc7 commit da9b281

File tree

4 files changed

+37
-1
lines changed

4 files changed

+37
-1
lines changed

.github/vale-styles/Yugabyte/spelling-exceptions.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ chatbots
109109
ChatOps
110110
checksummed
111111
checksumming
112+
CIDRs
112113
Citrix
113114
Citus
114115
clonable
@@ -691,6 +692,7 @@ syscall
691692
syscalls
692693
syslog
693694
systemd
695+
tabpane
694696
tablegroup
695697
tablegroups
696698
tablespace

docs/content/preview/yugabyte-cloud/cloud-basics/cloud-vpcs/cloud-vpc-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Each region in multi-region clusters must be deployed in a VPC. Depending on the
7878

7979
| Provider | Regional VPC setup |
8080
| :--- | :--- |
81-
| 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. |
81+
| 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). |
8282
| Azure | You need to create a VPC in each region where the cluster is to be deployed.<br/>Azure assigns the CIDR automatically. |
8383
| 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_. |
8484
| 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). |

docs/content/preview/yugabyte-cloud/cloud-basics/cloud-vpcs/managed-endpoint-aws.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@ To create an interface endpoint to connect to your cluster PSE, do the following
151151
152152
![AWS Create endpoint](/images/yb-cloud/managed-endpoint-aws-2.png)
153153
154+
Make sure the security groups in your application VPC allow internal connectivity. Otherwise, your application may not be able to reach the endpoint.
155+
154156
1. Click **Create endpoint**.
155157
156158
The endpoint is added to the Endpoints in AWS.

docs/content/preview/yugabyte-cloud/cloud-monitor/managed-integrations.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Currently, you can export data to the following tools:
2222
- [Datadog](https://docs.datadoghq.com/)
2323
- [Grafana Cloud](https://grafana.com/docs/grafana-cloud/)
2424
- [Sumo Logic](https://www.sumologic.com)
25+
- [Prometheus](https://prometheus.io/docs/introduction/overview/) {{<badge/tp>}}
2526

2627
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).
2728

@@ -95,6 +96,37 @@ To create an export configuration, do the following:
9596
1. Enter your installation token, access ID, and access key.
9697
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.
9798
1. Click **Test Configuration** to make sure your connection is working.
99+
1. Click **Create Configuration**.
100+
101+
{{% /tab %}}
102+
103+
{{% tab header="Prometheus" lang="prometheus" %}}
104+
105+
Prometheus integration is {{<badge/tp>}} and only available for clusters deployed on AWS.
106+
107+
The Prometheus integration requires the following:
108+
109+
- Prometheus instance
110+
- deployed in a VPC on AWS
111+
- [OLTP Receiver](https://prometheus.io/docs/prometheus/latest/querying/api/#otlp-receiver) feature flag enabled
112+
- 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.
113+
- VPC hosting the Prometheus instance has the following Inbound Security Group rules:
114+
- Allow HTTP inbound traffic on port 80 for Prometheus endpoint URL (HTTP)
115+
- Allow HTTPS inbound traffic on port 443 for Prometheus endpoint URL (HTTPS)
116+
117+
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.
118+
119+
- YugabyteDB Aeon cluster from which you want to export metrics
120+
- the cluster is [deployed in VPCs](../../cloud-basics/cloud-vpcs/cloud-add-vpc/) on AWS
121+
- each region VPC is peered with the VPC hosting Prometheus. See [Peer VPCs](../../cloud-basics/cloud-vpcs/cloud-add-vpc-aws/).
122+
123+
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/).
124+
125+
To create an export configuration, do the following:
126+
127+
1. On the **Integrations** page, click **Configure** for the Prometheus provider or, if a configuration is already available, **Add Configuration**.
128+
1. Enter a name for the configuration.
129+
1. Enter the endpoint URL of the Prometheus instance.
98130
1. Click **Create Configuration**.
99131

100132
{{% /tab %}}

0 commit comments

Comments
 (0)