Add opentelemetry.io docs #3070

austinlparker · 2021-03-29T15:52:09Z

Per open-telemetry/opentelemetry.io#472, we're adding the documentation content from the website to each repository. After a release of that requires documentation changes, please make an issue or PR in the website repository in order to have the changes mirrored.

jkwatson · 2021-03-29T15:57:29Z

website_docs/automatic_instrumentation.md

+|-----------------------------------|-----------------------------------|----------------------------------------------------------------------------------------------------|
+| otel.exporter=jaeger              | OTEL_EXPORTER=jaeger              | To select Jaeger exporter                                                                          |
+| otel.exporter.jaeger.endpoint     | OTEL_EXPORTER_JAEGER_ENDPOINT     | The Jaeger endpoint to connect to, default is "localhost:14250", currently only gRPC is supported. |
+| otel.exporter.jaeger.service.name | OTEL_EXPORTER_JAEGER_SERVICE_NAME | The service name of this JVM instance, default is "unknown".                                       |


this line should be deleted, as it is no longer a valid property.

jkwatson · 2021-03-29T15:57:40Z

website_docs/automatic_instrumentation.md

+|-----------------------------------|-----------------------------------|----------------------------------------------------------------------------------------------------|
+| otel.exporter=jaeger              | OTEL_EXPORTER=jaeger              | To select Jaeger exporter                                                                          |
+| otel.exporter.jaeger.endpoint     | OTEL_EXPORTER_JAEGER_ENDPOINT     | The Jaeger endpoint to connect to, default is "localhost:14250", currently only gRPC is supported. |
+| otel.exporter.jaeger.service.name | OTEL_EXPORTER_JAEGER_SERVICE_NAME | The service name of this JVM instance, default is "unknown".                                       |


Suggested change

| otel.exporter.jaeger.service.name | OTEL_EXPORTER_JAEGER_SERVICE_NAME | The service name of this JVM instance, default is "unknown". |

jkwatson · 2021-03-29T15:57:52Z

website_docs/automatic_instrumentation.md

+|-----------------------------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------|
+| otel.exporter=zipkin              | OTEL_EXPORTER=zipkin              | To select Zipkin exporter                                                                                             |
+| otel.exporter.zipkin.endpoint     | OTEL_EXPORTER_ZIPKIN_ENDPOINT     | The Zipkin endpoint to connect to, default is "http://localhost:9411/api/v2/spans". Currently only HTTP is supported. |
+| otel.exporter.zipkin.service.name | OTEL_EXPORTER_ZIPKIN_SERVICE_NAME | The service name of this JVM instance, default is "unknown".                                                          |


Suggested change

| otel.exporter.zipkin.service.name | OTEL_EXPORTER_ZIPKIN_SERVICE_NAME | The service name of this JVM instance, default is "unknown". |

jkwatson · 2021-03-29T15:59:29Z

website_docs/automatic_instrumentation.md

+
+| System property               | Environment variable          | Purpose                                                                            |
+|-------------------------------|-------------------------------|------------------------------------------------------------------------------------|
+| otel.exporter=prometheus      | OTEL_EXPORTER=prometheus      | To select Prometheus exporter                                                      |


this is no longer a valid property. should be otel.metrics.exporter I think

jkwatson · 2021-03-29T16:09:18Z

website_docs/automatic_instrumentation.md

+
+| System property              | Environment variable         | Purpose                                                                      |
+|------------------------------|------------------------------|------------------------------------------------------------------------------|
+| otel.exporter=logging        | OTEL_EXPORTER=logging        | To select logging exporter                                                   |


this should be otel.traces/metrics.exporter

jkwatson · 2021-03-29T16:11:24Z

website_docs/automatic_instrumentation.md

+| otel.config.max.events          | OTEL_CONFIG_MAX_EVENTS          | Maximum number of events per span (default: 128)     |
+| otel.config.max.links           | OTEL_CONFIG_MAX_LINKS           | Maximum number of links per span (default: 32)       |
+| otel.config.max.event.attrs     | OTEL_CONFIG_MAX_EVENT_ATTRS     | Maximum number of attributes per event (default: 32) |
+| otel.config.max.link.attrs      | OTEL_CONFIG_MAX_LINK_ATTRS      | Maximum number of attributes per link (default: 32)  |


these 6 properties are no longer valid. The ones in the autoconfigure README should be used.

jkwatson · 2021-03-29T16:11:58Z

website_docs/automatic_instrumentation.md

+for customizing its behavior, such as the `Resource` attached to spans or the
+`Sampler`.
+
+Because the auto instrumentation runs in a separate classpath than the


none of the instrumentation docs belong in this repo.

jkwatson · 2021-03-29T16:12:32Z

website_docs/automatic_instrumentation.md

+    <dependency>
+      <groupId>io.opentelemetry</groupId>
+      <artifactId>opentelemetry-api</artifactId>
+      <version>0.10.0</version>


this is very out of date. we should be recommending use of the bom, and, of course, version 1.0.1

jkwatson · 2021-03-29T16:13:02Z

website_docs/automatic_instrumentation.md

+}
+```
+
+### Configure `@WithSpan` annotation


this is for the instrumentation project

jkwatson · 2021-03-29T16:13:50Z

website_docs/automatic_instrumentation.md

+}
+```
+
+#### Suppressing `@WithSpan` instrumentation


this is more instrumentation agent docs that don't belong in this repo.

jkwatson · 2021-03-29T16:17:09Z

This content has a mishmash of API,SDK and auto-instrumentation agent documentation in it. I think we shouldn't have auto-instrumentation docs in this repo, but I don't know how to generate a unified set of docs for the website if they are split. @austinlparker Any thoughts on re-structuring the website docs so they can be maintained independently, between API/SDK and the agent/instrumentation repositories?

austinlparker · 2021-03-29T19:11:46Z

There's nothing that says 'Java' and 'Java Automatic Instrumentation' can't be different headings, but I think from an end-user's perspective looking for "getting started" guides we could have a website_docs folder in the auto-instrumentation repo and have that be committed to the same place in the website repo?

jkwatson · 2021-03-29T20:13:20Z

website_docs/_index.md

+
+| Traces | Metrics | Logs         |
+| ------ | ------- | ------------ |
+| Beta   | Alpha   | Experimental |


jkwatson · 2021-03-29T20:16:36Z

There's nothing that says 'Java' and 'Java Automatic Instrumentation' can't be different headings, but I think from an end-user's perspective looking for "getting started" guides we could have a website_docs folder in the auto-instrumentation repo and have that be committed to the same place in the website repo?

So, maybe it would be easiest for me to take the content of this PR and strip out the non-relevant-to-this-repo contents (and fix up the out-of-dateness), and submit it as a fresh PR for your review?

austinlparker · 2021-03-29T20:19:55Z

I don't really need to review your changes to it... I'm just trying to copy the current state of the website docs into each SIG repo, then you can make whatever changes you desire then we can apply those changes back to the website.

austinlparker · 2021-03-29T20:20:36Z

My next step is creating a GitHub action that will automatically make that PR for you when a new release is made.

jkwatson · 2021-03-29T20:24:19Z

I don't really need to review your changes to it... I'm just trying to copy the current state of the website docs into each SIG repo, then you can make whatever changes you desire then we can apply those changes back to the website.

ah, ok. I guess the thought it that it will be ok to have it be out of date/wrong initially, but it could be cleaned up and then pushed? Given that, can you put a disclaimer at the top of the file that it is not current, and then I'll remove that on my PR to clean it up?

austinlparker · 2021-03-29T20:29:20Z

Done

jkwatson

Thanks! once merged, I'll work on getting it current, and removing non-otel-java stuff.

jkwatson · 2021-03-30T15:31:02Z

merging. I'll pick up the cleanup later today.

add website docs

4a928ea

austinlparker requested review from anuraaga, arminru, bogdandrutu, carlosalberto, jkwatson, Oberon00, pavolloffay, thisthat and tylerbenson as code owners March 29, 2021 15:52

jkwatson reviewed Mar 29, 2021

View reviewed changes

website_docs/automatic_instrumentation.md

}

```

### Configure `@WithSpan` annotation

Copy link

Contributor

jkwatson Mar 29, 2021

Choose a reason for hiding this comment

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

this is for the instrumentation project

jkwatson reviewed Mar 29, 2021

View reviewed changes

austinlparker added 2 commits March 29, 2021 16:28

add out-of-date notice

0c264a1

add more out-of-date notices

d2ecd59

jkwatson approved these changes Mar 29, 2021

View reviewed changes

anuraaga approved these changes Mar 30, 2021

View reviewed changes

jkwatson merged commit 11fcc29 into open-telemetry:main Mar 30, 2021

chalin mentioned this pull request Aug 18, 2021

Process for authoritative 'getting started' guides open-telemetry/opentelemetry.io#472

Closed

chalin mentioned this pull request Apr 15, 2022

[website_docs] Questions about "Getting started", and OTel website 404s for Java docs open-telemetry/opentelemetry-java-examples#19

Closed

This was referenced Dec 19, 2021

Temurin JDK #4011

Merged

use Eclipse Temurin JDK docker image #4012

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add opentelemetry.io docs #3070

Add opentelemetry.io docs #3070

austinlparker commented Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson Mar 29, 2021 •

edited

Loading

jkwatson Mar 29, 2021 •

edited

Loading

jkwatson Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson commented Mar 29, 2021

austinlparker commented Mar 29, 2021

jkwatson Mar 29, 2021

jkwatson commented Mar 29, 2021

austinlparker commented Mar 29, 2021

austinlparker commented Mar 29, 2021

jkwatson commented Mar 29, 2021

austinlparker commented Mar 29, 2021

jkwatson left a comment

jkwatson commented Mar 30, 2021

	\| Beta \| Alpha \| Experimental \|
	\| GA \| Alpha \| Experimental \|

Add opentelemetry.io docs #3070

Add opentelemetry.io docs #3070

Conversation

austinlparker commented Mar 29, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkwatson Mar 29, 2021 • edited Loading

Choose a reason for hiding this comment

jkwatson Mar 29, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jkwatson commented Mar 29, 2021

austinlparker commented Mar 29, 2021

Choose a reason for hiding this comment

jkwatson commented Mar 29, 2021

austinlparker commented Mar 29, 2021

austinlparker commented Mar 29, 2021

jkwatson commented Mar 29, 2021

austinlparker commented Mar 29, 2021

jkwatson left a comment

Choose a reason for hiding this comment

jkwatson commented Mar 30, 2021

jkwatson Mar 29, 2021 •

edited

Loading

jkwatson Mar 29, 2021 •

edited

Loading