Skip to content
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

Observability refresh pt 3 #3688

Merged
merged 11 commits into from
Sep 12, 2023
Merged

Observability refresh pt 3 #3688

merged 11 commits into from
Sep 12, 2023

Conversation

hhunter-ms
Copy link
Collaborator

Description

OTEL collector review/pass
TOC update

Issue reference

PR will close: #3668

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms hhunter-ms self-assigned this Aug 21, 2023
@hhunter-ms hhunter-ms requested review from a team as code owners August 21, 2023 19:18
@@ -6,42 +6,48 @@ weight: 900
description: "How to use Dapr to push trace events through the OpenTelemetry Collector."
---

{{% alert title="Note" color="primary" %}}
Dapr directly writes traces using the OpenTelemetry (OTEL) protocol as the recommended method. For observability tools that support OTEL protocol, you do not need to use the OpenTelemetry Collector.
Dapr directly writes traces using the OpenTelemetry (OTEL) protocol as the **recommended** method. For observability tools that support OTEL protocol, you don't need to use the OpenTelemetry Collector.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not actually true (I did this update) and we should change this. The advice here is that you should always run the Open Telemetry collector on your hosting platform and use this to send OTEL events to the observability tool that support OTEL protocol. I suggest that we also include a nice diagram here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@msfussell is the current diagram in the doc ok to use, or does that need to be updated?
image

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@msfussell @hhunter-ms IMO the diagram is still correct but maybe the verbiage could be updated to something like:

"Dapr directly writes traces using the OpenTelemetry (OTEL) protocol as the recommended method. For observability tools that support OTEL protocol, it is still recommended to use the OpenTelemetry Collector since it allows your app to offload data quickly and includes other features like retries, batching and encryption. For more information, read the Open Telemetry documentation."

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @alicejgibbons! I updated the doc with your revised intro

msfussell and others added 3 commits August 24, 2023 10:12
@github-actions
Copy link

github-actions bot commented Sep 3, 2023

Stale PR, paging all reviewers

@github-actions github-actions bot added the stale label Sep 3, 2023
@hhunter-ms hhunter-ms removed the stale label Sep 12, 2023
Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

…ector/open-telemetry-collector.md

Signed-off-by: Mark Fussell <markfussell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Observability] Updates pt 3
4 participants