-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSSM-11010 [DOCS] Update OSSM tracing docs for ambient mode #102984
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shreyasiddhartha
wants to merge
1
commit into
openshift:service-mesh-docs-main
Choose a base branch
from
shreyasiddhartha:OSSM-11010-2
base: service-mesh-docs-main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+166
−15
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * service-mesh-docs-main/traces/ossm-distr-tracing-assembly.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="ossm-config-dt-ambient-mode_{context}"] | ||
| = Configuring {TempoName} with Service Mesh ambient mode | ||
|
|
||
| [role="_abstract"] | ||
| You can configure a {TempoShortName} with {SMProduct} ambient mode by using waypoint or gateway proxies to generate Layer 7 (L7) spans. The `ztunnel` component generates only Layer 4 (L4) data, so L7 trace spans appear only when a workload or service uses an attached waypoint or gateway proxy, The trace spans include telemetry from those proxies. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have installed the {TempoOperator}. See: link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/distributed_tracing/distr-tracing-tempo-installing#installing-the-tempo-operator_distr-tracing-tempo-installing[Installing the Tempo Operator]. | ||
| * You have installed the {OTELOperator}. See: link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/red_hat_build_of_opentelemetry/install-otel[Installing the Red Hat build of OpenTelemetry] | ||
| * You have installed a `TempoStack` which is configured in a `tempo` namespace. See: link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/distributed_tracing/distr-tracing-tempo-installing#installing-a-tempostack-instance_distr-tracing-tempo-installing[Installing a TempoStack instance]. | ||
| * You have created an {istio} instance. | ||
| .Procedure | ||
|
|
||
| . Navigate to the {OTELOperator} and install the `OpenTelemetryCollector` resource in the `istio-system` namespace, similar to the following example: | ||
| + | ||
| [source, yaml] | ||
| ---- | ||
| kind: OpenTelemetryCollector | ||
| apiVersion: opentelemetry.io/v1beta1 | ||
| metadata: | ||
| name: otel | ||
| namespace: istio-system | ||
| spec: | ||
| mode: deployment | ||
| observability: | ||
| metrics: {} | ||
| deploymentUpdateStrategy: {} | ||
| config: | ||
| exporters: | ||
| otlp: | ||
| endpoint: 'tempo-sample-distributor.tempo.svc.cluster.local:4317' | ||
| tls: | ||
| insecure: true | ||
| receivers: | ||
| otlp: | ||
| protocols: | ||
| grpc: | ||
| endpoint: '0.0.0.0:4317' | ||
| http: {} | ||
| service: | ||
| pipelines: | ||
| traces: | ||
| exporters: | ||
| - otlp | ||
| receivers: | ||
| - otlp | ||
| ---- | ||
|
|
||
| * `exporters.otlp.endpoint` defines the Tempo sample distributor service in a namespace such as `tempo`. | ||
| . Configure {SMProductName} {istio} custom resource (CR) to define a tracing provider in the `spec.values.meshConfig` field, similar to the following example: | ||
| + | ||
| [source, yaml] | ||
| ---- | ||
| apiVersion: sailoperator.io/v1 | ||
| kind: Istio | ||
| metadata: | ||
| # ... | ||
| name: default | ||
| spec: | ||
| namespace: istio-system | ||
| profile: ambient | ||
| # ... | ||
| values: | ||
| meshConfig: | ||
| enableTracing: true | ||
| extensionProviders: | ||
| - name: otel | ||
| opentelemetry: | ||
| port: 4317 | ||
| service: otel-collector.istio-system.svc.cluster.local | ||
| pilot: | ||
| trustedZtunnelNamespace: ztunnel | ||
| ---- | ||
|
|
||
| * `spec.values.meshConfig.extensionProviders.opentelemetry.service` defines the OpenTelemetry collector service in the `istio-system` namespace. | ||
| . Create an {istio} Telemetry CR to enable the tracing provider defined in the `spec.values.meshConfig.ExtensionProviders` field, similar to the following example: | ||
| + | ||
| [source, yaml] | ||
| ---- | ||
| apiVersion: telemetry.istio.io/v1 | ||
| kind: Telemetry | ||
| metadata: | ||
| name: otel-demo | ||
| namespace: istio-system | ||
| spec: | ||
| tracing: | ||
| - providers: | ||
| - name: otel | ||
| randomSamplingPercentage: 100 | ||
| ---- | ||
|
|
||
| + | ||
| [NOTE] | ||
| ==== | ||
| Once you can see the traces, lower the `randomSamplingPercentage` value or set it to `default` to reduce the number of requests. You can also use the `spec.targetRefs` field to enable tracing at a gateway or a waypoint level | ||
| ==== | ||
|
|
||
| . Optional: Use a single {istio} Telemetry resource for both a Prometheus metrics provider and a tracing provider by setting `spec.metrics.overrides.disabled` field to `false`. This enables the Prometheus metrics provider. You do not need this step if you have configured metrics through the OpenShift Cluster Monitoring approach described above. |
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,41 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // * service-mesh-docs-main/traces/ossm-distr-tracing-assembly.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="ossm-verifying-traces-ambient-mode_{context}"] | ||
| = Verifying traces in ambient mode | ||
|
|
||
| [role="_abstract"] | ||
| You can verify that the traces for the Bookinfo application are in ambient mode. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You have deployed the Bookinfo application in ambient mode to use the following example. For more information, see https://docs.redhat.com/en/documentation/red_hat_openshift_service_mesh/latest/html/installing/ossm-istio-ambient-mode#ossm-deploying-bookinfo-application-istio-ambient-mode_ossm-istio-ambient-mode[Deploying the Bookinfo application in Istio ambient mode]. | ||
|
|
||
| * You have deployed a waypoint proxy and enrolled the `bookinfo` namespace to use the waypoint. For more information, see https://docs.redhat.com/en/documentation/red_hat_openshift_service_mesh/latest/html/installing/ossm-istio-ambient-mode#ossm-deploying-waypoint-proxy_ossm-istio-ambient-mode[Deploying a waypoint proxy]. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Send some traffic to the Bookinfo `productpage` service for generating traces by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ curl "http://${GATEWAY_URL}/productpage" | grep "<title>" | ||
| ---- | ||
|
|
||
| . Verify that the Bookinfo application traces in a Tempo dashboard UI by running the following command: | ||
| + | ||
| [source,terminal] | ||
| ---- | ||
| $ oc get routes -n tempo tempo-sample-query-frontend | ||
| ---- | ||
|
|
||
| . Select the `bookinfo-gateway-istio.booinfo` or the `waypoint.bookinfo` service from the dashboard UI. | ||
|
|
||
| . Click *Find Traces*. | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| The {ocp-short-name} route for Tempo dashboard UI can be created from the `TempoStack` custom resource (CR) with `.spec.template.queryFrontend.jaegerQuery.ingress.type: route` field. | ||
| ==== |
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
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.
Around line 97. We need to add a note about
. Optional: Use a single {istio} Telemetry resource for both a Prometheus metrics provider and a tracing provider by setting
spec.metrics.overrides.disabledfield tofalse. This enables the Prometheus metrics provider. You do not need this step if you have configured metrics through the OpenShift Cluster Monitoring approach described above.That was requested for our sidecar mode tracing doc change as well.