OBSDOCS-1699: 3.8 docs preview for Suppport's hackathon #102927
+344
−58
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,5 +6,4 @@ | |
| [id="new-features-and-enhancements_{context}"] | ||
| = New features and enhancements | ||
|
|
||
| None. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * observability/otel/otel-configuration-of-otel-intro.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="otel-collector-profile-signal_{context}"] | ||
| = Profile signal | ||
|
|
||
| [role="_abstract"] | ||
| The Profile signal is an emerging telemetry data format for observing code execution and resource consumption. | ||
|
|
||
| :FeatureName: The Profile signal | ||
| include::snippets/technology-preview.adoc[leveloffset=+1] | ||
|
|
||
| The Profile signal allows you to pinpoint inefficient code down to specific functions. Such profiling allows you to precisely identify performance bottlenecks and resource inefficiencies down to the specific line of code. By correlating such high-fidelity profile data with traces, metrics, and logs, it enables comprehensive performance analysis and targeted code optimization in production environments. | ||
|
|
||
| Profiling can target an application or operating system: | ||
|
|
||
| * Using profiling to observe an application can help developers validate code performance, prevent regressions, and monitor resource consumption such as of memory and CPU, and thus identify and improve inefficient code. | ||
| * Using profiling to observe operating systems can provide insights into the infrastracture, system calls, kernel operations, and I/O wait times, and thus help in optimizing infrastructure for efficiency and cost savings. | ||
| .OpenTelemetry Collector custom resource with the enabled Profile signal | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA. |
||
| [source,yaml] | ||
| ---- | ||
| apiVersion: opentelemetry.io/v1beta1 | ||
| kind: OpenTelemetryCollector | ||
| metadata: | ||
| name: otel-profiles-collector | ||
| namespace: otel-profile | ||
| spec: | ||
| args: | ||
| feature-gates: service.profilesSupport # <1> | ||
| config: | ||
| receivers: | ||
| otlp: # <2> | ||
| protocols: | ||
| grpc: | ||
| endpoint: '0.0.0.0:4317' | ||
| http: | ||
| endpoint: '0.0.0.0:4318' | ||
| exporters: | ||
| otlp/pyroscope: | ||
| endpoint: "pyroscope.pyroscope-monitoring.svc.cluster.local:4317" # <3> | ||
| service: | ||
| pipelines: # <4> | ||
| profiles: | ||
| receivers: [otlp] | ||
| exporters: [otlp/pyroscope] | ||
| # ... | ||
| ---- | ||
| <1> Enables profiles by setting the `feature-gates` field as shown here. | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA. |
||
| <2> Configures the OTLP Receiver to set up the OpenTelemetry Collector to receive profiling data via the OTLP. | ||
| <3> Configures where to export profiles to, such as a storage. | ||
| <4> Defines a profiling pipeline, including a configuration for forwarding the received profile data to an OTLP-compatible profiling backend such as Grafana Pyroscope. | ||
|
|
||
| [role="_additional-resources"] | ||
| .Additional resources | ||
| * link:https://opentelemetry.io/docs/specs/otel/profiles/[OpenTelemetry Profiles] | ||
| * link:https://opentelemetry.io/docs/specs/semconv/general/profiles/[Profiles attributes] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA. |
||
| [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. | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA. |
||
| <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] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * observability/otel/otel-collector/otel-collector-receivers.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="otel-receivers-prometheus-remote-write-receiver_{context}"] | ||
| = Prometheus Remote Write Receiver | ||
|
|
||
| [role="_abstract"] | ||
| The Prometheus Remote Write Receiver receives metrics from Prometheus via the Remote Write protocol and converts them to the OpenTelemetry format. This receiver supports only the Prometheus Remote Write v2 protocol. | ||
|
|
||
| :FeatureName: The Prometheus Remote Write Receiver | ||
| include::snippets/technology-preview.adoc[] | ||
|
|
||
| .OpenTelemetry Collector custom resource with the enabled Prometheus Remote Write Receiver | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.BlockTitle: Block titles can only be assigned to examples, figures, and tables in DITA. |
||
| [source,yaml] | ||
| ---- | ||
| # ... | ||
| config: | ||
| receivers: | ||
| prometheusremotewrite: | ||
| endpoint: 0.0.0.0:9009 # <1> | ||
| service: | ||
| pipelines: | ||
| metrics: | ||
| receivers: [prometheusremotewrite] | ||
| # ... | ||
| ---- | ||
| <1> The endpoint where the receiver listens for Prometheus Remote Write requests. | ||
|
Collaborator
There was a problem hiding this comment. 🤖 [error] AsciiDocDITA.CalloutList: Callouts are not supported in DITA. |
||
|
|
||
| The following are the prerequisites for using the Prometheus Remote Write Receiver with Prometheus: | ||
|
|
||
| * Prometheus is started with the metadata WAL records feature flag enabled: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| ./prometheus --config.file config.yml --enable-feature=metadata-wal-records | ||
| ---- | ||
| * Prometheus Remote Write v2 Protocol is enabled in the Prometheus configuration file: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| remote_write: | ||
| - url: "<your_chosen_prometheus_remote_write_receiver_endpoint>" | ||
| protobuf_message: io.prometheus.write.v2.Request | ||
| ---- | ||
| * Native histograms are enabled in Prometheus. For more information about enabling native histograms in Prometheus, see the Prometheus documentation. | ||
| [role="_additional-resources"] | ||
| .Additional resources | ||
| * link:https://prometheus.io/docs/prometheus/latest/feature_flags/#metadata-wal-records[Metadata WAL Records] | ||
| * link:https://prometheus.io/docs/specs/prw/remote_write_spec_2_0/[Prometheus Remote-Write 2.0 specification [EXPERIMENTAL]] | ||
| * link:https://prometheus.io/docs/specs/native_histograms/[Native Histograms] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{TempoName}' or '{TempoShortName}' rather than the plain text product term 'Tempo', unless your use case is an exception.