From b593abace579f7d45e24711cc6511263d9ee1a58 Mon Sep 17 00:00:00 2001 From: Max Leonov Date: Wed, 19 Nov 2025 13:07:06 +0100 Subject: [PATCH] OBSDOCS-2504: Add Google Cloud Exporter docs --- ...tel-exporters-aws-cloudwatch-exporter.adoc | 2 + modules/otel-exporters-aws-emf-exporter.adoc | 2 + .../otel-exporters-google-cloud-exporter.adoc | 46 +++++++++++++++++++ modules/otel-forwarding-data-to-aws.adoc | 12 +++++ .../otel-forwarding-data-to-google-cloud.adoc | 12 +++++ .../otel-collector-exporters.adoc | 2 + .../otel/otel-forwarding-telemetry-data.adoc | 12 +++++ 7 files changed, 88 insertions(+) create mode 100644 modules/otel-exporters-google-cloud-exporter.adoc create mode 100644 modules/otel-forwarding-data-to-aws.adoc create mode 100644 modules/otel-forwarding-data-to-google-cloud.adoc diff --git a/modules/otel-exporters-aws-cloudwatch-exporter.adoc b/modules/otel-exporters-aws-cloudwatch-exporter.adoc index 4adecbbbe13a..2ade2dc070b6 100644 --- a/modules/otel-exporters-aws-cloudwatch-exporter.adoc +++ b/modules/otel-exporters-aws-cloudwatch-exporter.adoc @@ -24,6 +24,7 @@ include::snippets/technology-preview.adoc[] region: # <3> endpoint: # <4> log_retention: # <5> + role_arn: "" # <6> # ... ---- <1> Required. If the log group does not exist yet, it is automatically created. @@ -31,6 +32,7 @@ include::snippets/technology-preview.adoc[] <3> Optional. If the AWS region is not already set in the default credential chain, you must specify it. <4> Optional. You can override the default Amazon CloudWatch Logs service endpoint to which the requests are forwarded. You must include the protocol, such as `https://`, as part of the endpoint value. For the list of service endpoints by region, see link:https://docs.aws.amazon.com/general/latest/gr/cwl_region.html[Amazon CloudWatch Logs endpoints and quotas] (AWS General Reference). <5> Optional. With this parameter, you can set the log retention policy for new Amazon CloudWatch log groups. If this parameter is omitted or set to `0`, the logs never expire by default. Supported values for retention in days are `1`, `3`, `5`, `7`, `14`, `30`, `60`, `90`, `120`, `150`, `180`, `365`, `400`, `545`, `731`, `1827`, `2192`, `2557`, `2922`, `3288`, or `3653`. +<6> Optional. The AWS Identity and Access Management (IAM) role for uploading the logs segments to a different account. [role="_additional-resources"] .Additional resources diff --git a/modules/otel-exporters-aws-emf-exporter.adoc b/modules/otel-exporters-aws-emf-exporter.adoc index 08b05798fef9..004cfadca354 100644 --- a/modules/otel-exporters-aws-emf-exporter.adoc +++ b/modules/otel-exporters-aws-emf-exporter.adoc @@ -35,6 +35,7 @@ include::snippets/technology-preview.adoc[] endpoint: # <5> log_retention: # <6> namespace: # <7> + role_arn: "" # <8> # ... ---- <1> You can use the `log_group_name` parameter to customize the log group name or set the default `+/metrics/default+` value or the following placeholders: @@ -64,6 +65,7 @@ If no resource attribute is found in the resource attribute map, the placeholder <5> Optional. You can override the default Amazon CloudWatch Logs service endpoint to which the requests are forwarded. You must include the protocol, such as `https://`, as part of the endpoint value. For the list of service endpoints by region, see link:https://docs.aws.amazon.com/general/latest/gr/cwl_region.html[Amazon CloudWatch Logs endpoints and quotas] (AWS General Reference). <6> Optional. With this parameter, you can set the log retention policy for new Amazon CloudWatch log groups. If this parameter is omitted or set to `0`, the logs never expire by default. Supported values for retention in days are `1`, `3`, `5`, `7`, `14`, `30`, `60`, `90`, `120`, `150`, `180`, `365`, `400`, `545`, `731`, `1827`, `2192`, `2557`, `2922`, `3288`, or `3653`. <7> Optional. A custom namespace for the Amazon CloudWatch metrics. +<8> Optional. The AWS Identity and Access Management (IAM) role for uploading the metrics segments to a different account. [role="_additional-resources"] .Additional resources diff --git a/modules/otel-exporters-google-cloud-exporter.adoc b/modules/otel-exporters-google-cloud-exporter.adoc new file mode 100644 index 000000000000..c8a830ebf162 --- /dev/null +++ b/modules/otel-exporters-google-cloud-exporter.adoc @@ -0,0 +1,46 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-collector/otel-collector-exporters.adoc + +:_mod-docs-content-type: REFERENCE +[id="otel-exporters-google-cloud-exporter_{context}"] += Google Cloud Exporter + +[role="_abstract"] +You can use the Google Cloud Exporter to export telemetry data to Google Cloud Operations Suite. Using the Google Cloud Exporter, you can export metrics to Google Cloud Monitoring, logs to Google Cloud Logging, and traces to Google Cloud Trace. + +:FeatureName: The Google Cloud Exporter +include::snippets/technology-preview.adoc[] + +.OpenTelemetry Collector custom resource with the enabled Google Cloud Exporter +[source,yaml] +---- +# ... + env: + - name: GOOGLE_APPLICATION_CREDENTIALS + value: /var/secrets/google/key.json # <1> + volumeMounts: + - name: google-application-credentials + mountPath: /var/secrets/google + readOnly: true + volumes: + - name: google-application-credentials + secret: + secretName: google-application-credentials + config: + exporters: + googlecloud: + project: # <2> +# ... +---- +<1> The `GOOGLE_APPLICATION_CREDENTIALS` environment variable that points to the authentication `key.json` file. The `key.json` file is mounted as a secret volume to the OpenTelemetry Collector. +<2> Optional. The project identifier. If not specified, the project is automatically determined from the credentials. ++ +By default, the exporter sends telemetry data to the project specified in the `project` field of the exporter's configuration. You can have an override set up on a per-metric basis by using the `gcp.project.id` resource attribute. For example, if a metric has a label project, you can use the Group-by-Attributes Processor to promote it to a resource label, and then use the Resource Processor to rename the attribute from `project` to `gcp.project.id`. + +[role="_additional-resources"] +.Additional resources +* link:https://cloud.google.com/monitoring[Google Cloud Monitoring] +* link:https://cloud.google.com/logging[Google Cloud Logging] +* link:https://cloud.google.com/trace[Google Cloud Trace] +* link:https://cloud.google.com/iam/docs/workload-identity-federation-with-kubernetes#deploy[Google Cloud Guides: Configure Workload Identity Federation with Kubernetes] diff --git a/modules/otel-forwarding-data-to-aws.adoc b/modules/otel-forwarding-data-to-aws.adoc new file mode 100644 index 000000000000..3ec4f078312e --- /dev/null +++ b/modules/otel-forwarding-data-to-aws.adoc @@ -0,0 +1,12 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-forwarding-telemetry-data.adoc + +:_mod-docs-content-type: CONCEPT +[id="otel-forwarding-data-to-aws_{context}"] += Forwarding telemetry data to AWS + +[role="_abstract"] +You can have metrics, logs, and traces forwarded to the Amazon CloudWatch and AWS X-Ray services by using the following exporters of the OpenTelemetry Collector: AWS CloudWatch Logs Exporter, AWS EMF Exporter, and AWS X-Ray Exporter. + +// Currently, this docs repository does not permit linking from here to the sections for AWS CloudWatch Logs Exporter, AWS EMF Exporter, and AWS X-Ray Exporter. See the xref to the "Exporters" page placed in observability/otel/otel-forwarding-telemetry-data.adoc. diff --git a/modules/otel-forwarding-data-to-google-cloud.adoc b/modules/otel-forwarding-data-to-google-cloud.adoc new file mode 100644 index 000000000000..63eee4836700 --- /dev/null +++ b/modules/otel-forwarding-data-to-google-cloud.adoc @@ -0,0 +1,12 @@ +// Module included in the following assemblies: +// +// * observability/otel/otel-forwarding-telemetry-data.adoc + +:_mod-docs-content-type: CONCEPT +[id="otel-forwarding-data-to-google-cloud_{context}"] += Forwarding telemetry data to Google Cloud + +[role="_abstract"] +You can have metrics, logs, and traces forwarded to Google Cloud Operations Suite by using the Google Cloud Exporter of the OpenTelemetry Collector. + +// Currently, this docs repository does not permit linking from here to the Google Cloud Exporter section. See the xref to the "Exporters" page placed in observability/otel/otel-forwarding-telemetry-data.adoc. diff --git a/observability/otel/otel-collector/otel-collector-exporters.adoc b/observability/otel/otel-collector/otel-collector-exporters.adoc index aa37013aea96..4c8b5b652e87 100644 --- a/observability/otel/otel-collector/otel-collector-exporters.adoc +++ b/observability/otel/otel-collector/otel-collector-exporters.adoc @@ -33,6 +33,8 @@ include::modules/otel-exporters-aws-xray-exporter.adoc[leveloffset=+1] include::modules/otel-exporters-file-exporter.adoc[leveloffset=+1] +include::modules/otel-exporters-google-cloud-exporter.adoc[leveloffset=+1] + [id="additional-resources_{context}"] [role="_additional-resources"] == Additional resources diff --git a/observability/otel/otel-forwarding-telemetry-data.adoc b/observability/otel/otel-forwarding-telemetry-data.adoc index 47128f1f2617..bf86771546c4 100644 --- a/observability/otel/otel-forwarding-telemetry-data.adoc +++ b/observability/otel/otel-forwarding-telemetry-data.adoc @@ -14,6 +14,18 @@ include::modules/otel-forwarding-logs-to-tempostack.adoc[leveloffset=+1] include::modules/otel-forwarding-data-to-third-party-systems.adoc[leveloffset=+1] +include::modules/otel-forwarding-data-to-aws.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* xref:../../observability/otel/otel-collector/otel-collector-exporters.adoc#otel-collector-exporters[Exporters] + +include::modules/otel-forwarding-data-to-google-cloud.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* xref:../../observability/otel/otel-collector/otel-collector-exporters.adoc#otel-collector-exporters[Exporters] + [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources