diff --git a/modules/otel-forwarding-data-to-aws.adoc b/modules/otel-forwarding-data-to-aws.adoc new file mode 100644 index 000000000000..3c61b4476e4f --- /dev/null +++ b/modules/otel-forwarding-data-to-aws.adoc @@ -0,0 +1,11 @@ +//Module included in the following assemblies: +// +// * observability/otel/otel-forwarding-data.adoc + +:_mod-docs-content-type: PROCEDURE +[id="otel-forwarding-data-to-googlecloud_{context}"] += Forwarding telemetry data to AWS + +You can deploy the OpenTelemetry Collector to forward metrics, logs and traces to the AWS CloudWatch and X-Ray. + +TODO Add link to the AWF CloudWatch, EMF and X-Ray exporter from the collector configuration page. \ No newline at end of file diff --git a/modules/otel-forwarding-data-to-googlecloud.adoc b/modules/otel-forwarding-data-to-googlecloud.adoc new file mode 100644 index 000000000000..ae5855e542a3 --- /dev/null +++ b/modules/otel-forwarding-data-to-googlecloud.adoc @@ -0,0 +1,11 @@ +//Module included in the following assemblies: +// +// * observability/otel/otel-forwarding-data.adoc + +:_mod-docs-content-type: PROCEDURE +[id="otel-forwarding-data-to-googlecloud_{context}"] += Forwarding telemetry data to Google Cloud + +You can deploy the OpenTelemetry Collector to forward metrics, logs and traces to the Google Cloud by using the Google Cloud exporter. + +TODO Add link to the googlecloud exporter from the collector configuration page. \ No newline at end of file diff --git a/observability/otel/otel-collector/otel-collector-exporters.adoc b/observability/otel/otel-collector/otel-collector-exporters.adoc index ece479afefe0..e7edc79cb137 100644 --- a/observability/otel/otel-collector/otel-collector-exporters.adoc +++ b/observability/otel/otel-collector/otel-collector-exporters.adoc @@ -311,6 +311,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. @@ -318,6 +319,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 X-Ray segments to a different account. [role="_additional-resources"] .Additional resources @@ -357,6 +359,7 @@ include::snippets/technology-preview.adoc[] endpoint: # <5> log_retention: # <6> namespace: # <7> + role_arn: "" # <8> # ... ---- <1> Customized log group name. @@ -366,6 +369,7 @@ include::snippets/technology-preview.adoc[] <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 X-Ray segments to a different account. [discrete] [id="log-group-name_{context}"] @@ -445,6 +449,50 @@ include::snippets/technology-preview.adoc[] // * link:https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/configure-auth.html[Configure Authentication] (AWS SDK for Go v2 Developer Guide) * link:https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html[IAM roles] (AWS Identity and Access Management User Guide) +[id="googlecloud-exporter_{context}"] +== Google Cloud Exporter + +The Google Cloud Exporter can be used converts the OpenTelemetry spans, metrics and logs to the Google Cloud Trace, Monitoring, and Logging formats and then sends them directly to the Google Cloud operations suite (formerly Stackdriver). + +The Goolge Cloud Exporter can be used to send metrics to Google Cloud Monitoring (formerly Stackdriver), traces to Google Cloud Trace, and logs to Google Cloud Logging. + +: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: # <3> +# ... +---- +<1> The `GOOGLE_APPLICATION_CREDENTIALS` environment variable which points to the authentication `key.json` file. The `key.json` file is mounted as a secret volume to the collector. +<2> Optional project identifier. If not specified, the project is determined from the credentials. + +[role="_additional-resources"] +.Additional resources +* link:https://cloud.google.com/monitoring?hl=en[Google Cloud Monitoring] +* link:https://cloud.google.com/logging?hl=en[Google Cloud Logging] +* link:https://cloud.google.com/trace?hl=en[Google Cloud Trace] +* link:https://cloud.google.com/iam/docs/workload-identity-federation-with-kubernetes#deploy[Google Workflow Identity Federation docs] + +=== Multi-Project exporting +By default, the exporter sends telemetry to the project specified by project in the configuration. This can be overridden on a per-metrics basis using the `gcp.project.id` resource attribute. For example, if a metric has a label project, you could use the groupbyattrs processor to promote it to a resource label, and the resource processor to rename the attribute from project to `gcp.project.id`. + [id="file-exporter_{context}"] == File Exporter diff --git a/observability/otel/otel-forwarding-telemetry-data.adoc b/observability/otel/otel-forwarding-telemetry-data.adoc index 938baee81a51..21770a165c2f 100644 --- a/observability/otel/otel-forwarding-telemetry-data.adoc +++ b/observability/otel/otel-forwarding-telemetry-data.adoc @@ -11,3 +11,7 @@ You can use the OpenTelemetry Collector to forward your telemetry data. include::modules/otel-forwarding-traces.adoc[leveloffset=+1] include::modules/otel-forwarding-logs-to-tempostack.adoc[leveloffset=+1] + +include::modules/otel-forwarding-data-to-googlecloud.adoc[leveloffset=+1] + +include::modules/otel-forwarding-data-to-aws.adoc[leveloffset=+1]