Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions modules/otel-exporters-aws-cloudwatch-exporter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ include::snippets/technology-preview.adoc[]
region: <aws_region_of_log_stream> # <3>
endpoint: <protocol><service_endpoint_of_amazon_cloudwatch_logs> # <4>
log_retention: <supported_value_in_days> # <5>
role_arn: "<iam_role>" # <6>
# ...
----
<1> Required. If the log group does not exist yet, it is automatically created.
<2> Required. If the log stream does not exist yet, it is automatically created.
<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
Expand Down
2 changes: 2 additions & 0 deletions modules/otel-exporters-aws-emf-exporter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ include::snippets/technology-preview.adoc[]
endpoint: <protocol><endpoint> # <5>
log_retention: <supported_value_in_days> # <6>
namespace: <custom_namespace> # <7>
role_arn: "<iam_role>" # <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:
Expand Down Expand Up @@ -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
Expand Down
46 changes: 46 additions & 0 deletions modules/otel-exporters-google-cloud-exporter.adoc
Original file line number Diff line number Diff line change
@@ -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]
12 changes: 12 additions & 0 deletions modules/otel-forwarding-data-to-aws.adoc
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 12 additions & 0 deletions modules/otel-forwarding-data-to-google-cloud.adoc
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions observability/otel/otel-forwarding-telemetry-data.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down