Skip to content

Commit b593aba

Browse files
committed
OBSDOCS-2504: Add Google Cloud Exporter docs
1 parent d3b2426 commit b593aba

7 files changed

+88
-0
lines changed

modules/otel-exporters-aws-cloudwatch-exporter.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,15 @@ include::snippets/technology-preview.adoc[]
2424
region: <aws_region_of_log_stream> # <3>
2525
endpoint: <protocol><service_endpoint_of_amazon_cloudwatch_logs> # <4>
2626
log_retention: <supported_value_in_days> # <5>
27+
role_arn: "<iam_role>" # <6>
2728
# ...
2829
----
2930
<1> Required. If the log group does not exist yet, it is automatically created.
3031
<2> Required. If the log stream does not exist yet, it is automatically created.
3132
<3> Optional. If the AWS region is not already set in the default credential chain, you must specify it.
3233
<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).
3334
<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`.
35+
<6> Optional. The AWS Identity and Access Management (IAM) role for uploading the logs segments to a different account.
3436

3537
[role="_additional-resources"]
3638
.Additional resources

modules/otel-exporters-aws-emf-exporter.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ include::snippets/technology-preview.adoc[]
3535
endpoint: <protocol><endpoint> # <5>
3636
log_retention: <supported_value_in_days> # <6>
3737
namespace: <custom_namespace> # <7>
38+
role_arn: "<iam_role>" # <8>
3839
# ...
3940
----
4041
<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
6465
<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).
6566
<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`.
6667
<7> Optional. A custom namespace for the Amazon CloudWatch metrics.
68+
<8> Optional. The AWS Identity and Access Management (IAM) role for uploading the metrics segments to a different account.
6769

6870
[role="_additional-resources"]
6971
.Additional resources
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/otel/otel-collector/otel-collector-exporters.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="otel-exporters-google-cloud-exporter_{context}"]
7+
= Google Cloud Exporter
8+
9+
[role="_abstract"]
10+
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.
11+
12+
:FeatureName: The Google Cloud Exporter
13+
include::snippets/technology-preview.adoc[]
14+
15+
.OpenTelemetry Collector custom resource with the enabled Google Cloud Exporter
16+
[source,yaml]
17+
----
18+
# ...
19+
env:
20+
- name: GOOGLE_APPLICATION_CREDENTIALS
21+
value: /var/secrets/google/key.json # <1>
22+
volumeMounts:
23+
- name: google-application-credentials
24+
mountPath: /var/secrets/google
25+
readOnly: true
26+
volumes:
27+
- name: google-application-credentials
28+
secret:
29+
secretName: google-application-credentials
30+
config:
31+
exporters:
32+
googlecloud:
33+
project: # <2>
34+
# ...
35+
----
36+
<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.
37+
<2> Optional. The project identifier. If not specified, the project is automatically determined from the credentials.
38+
+
39+
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`.
40+
41+
[role="_additional-resources"]
42+
.Additional resources
43+
* link:https://cloud.google.com/monitoring[Google Cloud Monitoring]
44+
* link:https://cloud.google.com/logging[Google Cloud Logging]
45+
* link:https://cloud.google.com/trace[Google Cloud Trace]
46+
* link:https://cloud.google.com/iam/docs/workload-identity-federation-with-kubernetes#deploy[Google Cloud Guides: Configure Workload Identity Federation with Kubernetes]
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/otel/otel-forwarding-telemetry-data.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="otel-forwarding-data-to-aws_{context}"]
7+
= Forwarding telemetry data to AWS
8+
9+
[role="_abstract"]
10+
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.
11+
12+
// 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.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * observability/otel/otel-forwarding-telemetry-data.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="otel-forwarding-data-to-google-cloud_{context}"]
7+
= Forwarding telemetry data to Google Cloud
8+
9+
[role="_abstract"]
10+
You can have metrics, logs, and traces forwarded to Google Cloud Operations Suite by using the Google Cloud Exporter of the OpenTelemetry Collector.
11+
12+
// 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.

observability/otel/otel-collector/otel-collector-exporters.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,8 @@ include::modules/otel-exporters-aws-xray-exporter.adoc[leveloffset=+1]
3333

3434
include::modules/otel-exporters-file-exporter.adoc[leveloffset=+1]
3535

36+
include::modules/otel-exporters-google-cloud-exporter.adoc[leveloffset=+1]
37+
3638
[id="additional-resources_{context}"]
3739
[role="_additional-resources"]
3840
== Additional resources

observability/otel/otel-forwarding-telemetry-data.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,18 @@ include::modules/otel-forwarding-logs-to-tempostack.adoc[leveloffset=+1]
1414

1515
include::modules/otel-forwarding-data-to-third-party-systems.adoc[leveloffset=+1]
1616

17+
include::modules/otel-forwarding-data-to-aws.adoc[leveloffset=+1]
18+
19+
[role="_additional-resources"]
20+
.Additional resources
21+
* xref:../../observability/otel/otel-collector/otel-collector-exporters.adoc#otel-collector-exporters[Exporters]
22+
23+
include::modules/otel-forwarding-data-to-google-cloud.adoc[leveloffset=+1]
24+
25+
[role="_additional-resources"]
26+
.Additional resources
27+
* xref:../../observability/otel/otel-collector/otel-collector-exporters.adoc#otel-collector-exporters[Exporters]
28+
1729
[role="_additional-resources"]
1830
[id="additional-resources_{context}"]
1931
== Additional resources

0 commit comments

Comments
 (0)