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.

Sign up for GitHub

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

Jump to bottom

[DOCS] OpenTelemetry - add OpenTelemetry protocol support content #4964

Merged
merged 8 commits into from
Mar 22, 2021
Merged

[DOCS] OpenTelemetry - add OpenTelemetry protocol support content #4964

merged 8 commits into from
Mar 22, 2021

Conversation

EamonnTP
Copy link
Contributor

@EamonnTP EamonnTP commented Mar 16, 2021 •
edited
Loading

Summary

This PR updates the current OpenTelemetry integration docs with the recent support for OTLP/gRPC on the standard port.

To accommodate the new content, I have restructured the content to include both the Elastic OpenTelemetry integrations: Elastic exporter on the OpenTelemetry collector and APM Server native support of OpenTelemetry protocol. I have also included updated architecture diagrams for both integrations.

Docs preview

https://apm-server_4964.docs-preview.app.elstc.co/guide/en/apm/get-started/master/open-telemetry-elastic.html

Related issue

Closes #4678

@EamonnTP EamonnTP requested review from cyrille-leclerc, axw and a team March 16, 2021 13:55
@apmmachine
Copy link
Contributor

apmmachine commented Mar 16, 2021 •
edited
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: Pull request #4964 updated

  • Start Time: 2021-03-22T16:23:18.799+0000

  • Duration: 43 min 47 sec

  • Commit: fb59eea

Test stats 🧪

Test Results
Failed 0
Passed 6250
Skipped 120
Total 6370

Trends 🧪

Image of Build Times

Image of Tests

dedemorton
dedemorton reviewed Mar 16, 2021
View reviewed changes
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

I hope all my comments are applied properly. GitHub is showing duplicate comments. :-/

docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated
[[open-telemetry-elastic-get-started]]
==== Get started
| *Elastic exporter* | The exporter translates the OpenTelemetry trace data collected from your services
and the metrics data collected from your applications and infrastructure to Elastic's protocol.
Copy link
Contributor

Choose a reason for hiding this comment

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

This sentence is a mouthful. I would find a way to break this into a couple of sentences that are easier to parse.

Also, I'm not sure what protocol we mean when we say "Elastic's protocol".

docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc

The APM Server native support of OpenTelemetry protocol integration allows you to send collected telemetry data directly from your applications to APM Server.
Trace data collected from your services and the metrics data collected from your applications and infrastructure are sent using the
OpenTelemetry protocol.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the same as the "Elastic's protocol" that you refer to previously? If so, I wound be consistent.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No this is different. This refers to the OpenTelemetry protocol (OTLP).

Copy link
Member

@bmorelli25 bmorelli25 Mar 18, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

"Elastic's protocol" refers to how Elastic APM Agents send data to a collector, like APM Server. "OTLP" refers to how OpenTelemetry agents send data to a collector, like the OTEL collector. APM Server can now receive native OTLP data.

axw
axw reviewed Mar 17, 2021
View reviewed changes
Copy link
Member

@axw axw left a comment

Choose a reason for hiding this comment

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

Looks good! I have only reviewed technical details.

docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
bmorelli25
bmorelli25 reviewed Mar 18, 2021
View reviewed changes
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Looking great! A few suggestions.

docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
docs/guide/opentelemetry-elastic.asciidoc Outdated Show resolved Hide resolved
@cyrille-leclerc cyrille-leclerc changed the title [DOCS] OpenTelemetry - add gRPC support content [DOCS] OpenTelemetry - add OpenTelemetry protocol support content Mar 22, 2021
@bmorelli25 bmorelli25 merged commit f8471bf into elastic:master Mar 22, 2021
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Mar 22, 2021
@cyrille-leclerc @bmorelli25
docs: Add OpenTelemetry protocol support content (elastic#4964)
8642587 
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
@bmorelli25 bmorelli25 mentioned this pull request Mar 22, 2021
Merged
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Mar 22, 2021
@cyrille-leclerc @bmorelli25
docs: Add OpenTelemetry protocol support content (elastic#4964)
8089e82 
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
@bmorelli25 bmorelli25 mentioned this pull request Mar 22, 2021
Merged
axw pushed a commit that referenced this pull request Mar 23, 2021
@bmorelli25 @cyrille-leclerc
docs: Add OpenTelemetry protocol support content (#4964) (#4983)
74b0823 
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>

Co-authored-by: EamonnTP <Eamonn.Smith@elastic.co>
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
axw pushed a commit that referenced this pull request Mar 23, 2021
@bmorelli25 @cyrille-leclerc
docs: Add OpenTelemetry protocol support content (#4964) (#4982)
65b640e 
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>

Co-authored-by: EamonnTP <Eamonn.Smith@elastic.co>
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
@EamonnTP EamonnTP deleted the otel-content-update branch March 23, 2021 09:19
@bmorelli25 bmorelli25 mentioned this pull request Aug 13, 2021
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@axw axw axw left review comments

@dedemorton dedemorton dedemorton left review comments

@cyrille-leclerc cyrille-leclerc cyrille-leclerc approved these changes

@bmorelli25 bmorelli25 bmorelli25 approved these changes

Assignees
No one assigned
Labels
docs v7.12.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[OTLP] Document support for OTLP/gRPC on the standard port
6 participants
@EamonnTP @apmmachine @cyrille-leclerc @axw @bmorelli25 @dedemorton