Skip to content

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

Merged
bmorelli25 merged 8 commits intoelastic:masterfrom
EamonnTP:otel-content-update
Mar 22, 2021
Merged

[DOCS] OpenTelemetry - add OpenTelemetry protocol support content#4964
bmorelli25 merged 8 commits intoelastic:masterfrom
EamonnTP:otel-content-update

Conversation

@EamonnTP
Copy link
Copy Markdown
Contributor

@EamonnTP EamonnTP commented Mar 16, 2021

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

@ghost
Copy link
Copy Markdown

ghost commented Mar 16, 2021

💚 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

Copy link
Copy Markdown
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. :-/

[[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
Copy Markdown
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".


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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Member

@bmorelli25 bmorelli25 Mar 18, 2021

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.

Copy link
Copy Markdown
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.

Copy link
Copy Markdown
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.

@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
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request Mar 22, 2021
Co-authored-by: Cyrille Le Clerc <cyrille.leclerc@elastic.co>
Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
axw pushed a commit that referenced this pull request Mar 23, 2021
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
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[OTLP] Document support for OTLP/gRPC on the standard port

5 participants