Skip to content

Commit 5ed122b

Browse files
addetzaddetz
authored
docs: adjust OTel guide DOC-2134 (#8170)
* docs: adjust OTel guide DOC-2134 * empty
1 parent bdbfdc3 commit 5ed122b

File tree

4 files changed

+32
-10
lines changed

4 files changed

+32
-10
lines changed

‎docs/docs-content/clusters/cluster-management/monitoring/open-telemetry.md‎

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ reducing duplication.
4141
## Prerequisites
4242

4343
- A Palette account.
44-
- Three or more healthy [VMware](../../data-center/vmware/vmware.md), [MAAS](../../data-center/maas/maas.md) or
45-
[Edge](../../edge/edge.md) clusters.
44+
- Three or more healthy [Public Cloud](../../public-cloud/public-cloud.md),
45+
[Data Center](../../data-center/data-center.md) or [Edge](../../edge/edge.md) clusters.
4646
- Network connectivity between the clusters.
4747

4848
## Deploy an OpenTelemetry Monitoring Stack
@@ -63,11 +63,11 @@ them to your deployed healthy clusters.
6363
Add the following packs in your cluster profile with customizations that suit your environment. Then, select
6464
**Next**.
6565

66-
| **Pack** | **Version** | **Registry** | **Customization** |
67-
| ------------ | ----------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
68-
| MetalLB | 0.13.x | Palette Registry (OCI) | Set an IP range that is available in your environment in the `manifests.metallb.addresses` field. |
69-
| PostgreSQL | 1.22.x | Palette Registry (OCI) | No customization required. |
70-
| Open Observe | 0.14.x | Palette Registry (OCI) | Set a user email in the `charts.openobserve.auth.ZO_ROOT_USER_EMAIL` field or leave the default value of `[email protected]`. Set a user password in the `charts.openobserve.auth.ZO_ROOT_USER_PASSWORD` field. |
66+
| **Pack** | **Version** | **Registry** | **Customization** |
67+
| ------------ | ----------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
68+
| MetalLB | 0.13.x | Palette Registry (OCI) | This pack is only required for Data Center and Edge clusters. Set an IP range that is available in your environment in the `manifests.metallb.addresses` field. |
69+
| PostgreSQL | 1.22.x | Palette Registry (OCI) | No customization required. |
70+
| Open Observe | 0.14.x | Palette Registry (OCI) | Set a user email in the `charts.openobserve.auth.ZO_ROOT_USER_EMAIL` field or leave the default value of `[email protected]`. Set a user password in the `charts.openobserve.auth.ZO_ROOT_USER_PASSWORD` field. Set `charts.openobserve.config.ZO_LOCAL_MODE` to true. |
7171

7272
Construct a Base64 encoding of the credentials you have configured in the format `useremail:password` in the Open
7373
Observe pack. For example, the string `[email protected]:admin` is encoded to
@@ -76,6 +76,17 @@ them to your deployed healthy clusters.
7676
Review the configuration you have provided and click **Finish Configuration** to save your cluster profile. This
7777
profile configures and deploys the Open Observe dashboard.
7878

79+
:::tip
80+
81+
The Open Observe pack allows you to save metrics information on the pod or in an S3 bucket. This guide saves metrics
82+
on the pod. Provide the following configurations if you want to persist your metrics to an existing S3 bucket.
83+
84+
- Set `charts.openobserve.config.ZO_LOCAL_MODE` to false.
85+
- Fill in an access key in the field `charts.openobserve.auth.ZO_S3_ACCESS_KEY` and a secret key in the field `charts.openobserve.auth.ZO_S3_SECRET_KEY`.
86+
- Fill in the region of your S3 bucket in the field `charts.openobserve.config.ZO_S3_REGION_NAME` and the name of your bucket in the field `charts.openobserve.config.ZO_S3_BUCKET_NAME`.
87+
88+
:::
89+
7990
4. Navigate to the left main menu and select **Clusters** to view the cluster profile page. Select one of the healthy
8091
clusters that you have deployed as a prerequisite to this guide. The **Overview** tab appears.
8192

@@ -107,12 +118,23 @@ them to your deployed healthy clusters.
107118

108119
| **Pack** | **Version** | **Registry** | **Customization** |
109120
| -------------- | ----------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
110-
| MetalLB | 0.13.x | Palette Registry (OCI) | Set an IP range that is available in your environment in the `manifests.metallb.addresses` field. |
111-
| Open Telemetry | 0.127.x | Palette Registry (OCI) | Click **Presets**. Select **Enable** under the **central-collector** section and select **OpenObserve** under the **export** section. Replace the domain placeholder in the `charts.opentelemetry-collector.config.exporters.otlphttp/openobserve.endpoint` field with the service address of the exporter service you deployed in the [Create and Deploy the Exporter Cluster Profile](#create-and-deploy-the-exporter-cluster-profile) section. Replace the password placeholder in the `charts.opentelemetry-collector.config.exporters.otlphttp/openobserve.headers.Authorization` field with the Base64-encoded value you made a note of in Step 3 of the [Create and Deploy the Exporter Cluster Profile](#create-and-deploy-the-exporter-cluster-profile) section, keeping the prefix `Basic`. For example, `Basic YWRtaW5Ab3Blbm9ic2VydmUuZGV2OmFkbWl` uses the encoded sample value `[email protected]:admin`. |
121+
| MetalLB | 0.13.x | Palette Registry (OCI) | This pack is only required for Data Center and Edge clusters. Set an IP range that is available in your environment in the `manifests.metallb.addresses` field. |
122+
| Open Telemetry | 0.132.x | Palette Registry (OCI) | Click **Presets**. Select **Enable** under the **central-collector** section and select **OpenObserve** under the **export** section. Replace the domain placeholder in the `charts.opentelemetry-collector.config.exporters.otlphttp/openobserve.endpoint` field with the service address of the exporter service you deployed in the [Create and Deploy the Exporter Cluster Profile](#create-and-deploy-the-exporter-cluster-profile) section. Replace the password placeholder in the `charts.opentelemetry-collector.config.exporters.otlphttp/openobserve.headers.Authorization` field with the Base64-encoded value you made a note of in Step 3 of the [Create and Deploy the Exporter Cluster Profile](#create-and-deploy-the-exporter-cluster-profile) section, keeping the prefix `Basic`. For example, `Basic YWRtaW5Ab3Blbm9ic2VydmUuZGV2OmFkbWl` uses the encoded sample value `[email protected]:admin`. |
112123

113124
Review the configuration you have provided and click **Finish Configuration** to save your cluster profile. This
114125
profile configures and deploys the Open Telemetry central collector.
115126

127+
:::info
128+
129+
The OpenTelemetry pack supports auto-instrumentation for Java, Python, Node.js, .NET and Go applications. This
130+
capability allows you to collect traces, metrics, and logs from your applications without changing their source
131+
code. You can enable the instrumentation by adding annotations to your workloads.
132+
133+
Refer to the <VersionedLink text="OpenTelemetry Collector" url="/integrations/packs/?pack=opentelemetry" /> pack
134+
documentation for further details.
135+
136+
:::
137+
116138
3. Navigate to the left main menu and select **Clusters** to view the cluster profile page. Select one of the healthy
117139
clusters that you have deployed as a prerequisite to this guide. The **Overview** tab appears.
118140

@@ -123,7 +145,7 @@ them to your deployed healthy clusters.
123145
configuration and click **Save**.
124146

125147
4. Select the **Overview** tab and monitor the progress of your add-on profile. This may take a few minutes. You will
126-
find six services deployed once the add-on profile is correctly applied.
148+
find five services deployed once the add-on profile is correctly applied.
127149

128150
Make a note of the address of the services by copying the link under port **4317**.
129151

‎static/assets/docs/images/clusters_cluster-management_monitoring_open-telemetry_central-collector-deployed.webp‎

-2.41 KB
Loading

‎static/assets/docs/images/clusters_cluster-management_monitoring_open-telemetry_exporter-deployed.webp‎

-5.61 KB
Loading

‎static/assets/docs/images/clusters_cluster-management_monitoring_open-telemetry_workload-deployed.webp‎

7.08 KB
Loading

0 commit comments

Comments
 (0)