Skip to content

Commit

Permalink
Add basic .NET Automatic Instrumentation doc page (#1740)
Browse files Browse the repository at this point in the history
  • Loading branch information
pellared authored Sep 13, 2022
1 parent 4d41d68 commit ea11b25
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 5 deletions.
6 changes: 6 additions & 0 deletions content/en/docs/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ A key-value pair. Used across telemetry signals - e.g. in [`Traces`](#trace) to
attach data to a [`Span`](#span), or in [`Metrics`](#metric). See [attribute
spec][attribute].

### **Automatic Instrumentation**

Refers to telemetry collection methods that do not require the end-user to
modify application's source code. Methods vary by programming language, and
examples include bytecode injection or monkey patching.

### **Baggage**

A mechanism for propagating name/value pairs to help establish a causal
Expand Down
28 changes: 28 additions & 0 deletions content/en/docs/instrumentation/net/automatic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Automatic Instrumentation
linkTitle: Automatic
weight: 3
---

You can use [automatic instrumentation](/docs/reference/specification/glossary/#automatic-instrumentation)
to initalize [signal](/docs/reference/specification/glossary/#signals) providers
and generate telemetry data for supported [instrumented libraries](/docs/reference/specification/glossary/#instrumented-library)
without modifying the application's source code.

[Here][release] you can find the latest release of
OpenTelemetry .NET Automatic Instrumentation.

You can find the documentation in the [project's repository][repo].

## Next steps

After you have set up instrumentation libraries, you may want to add [manual
instrumentation](/docs/instrumentation/net/manual) to collect custom telemetry
data.

If you do not want to rely on automatic instrumentation,
which is currently in beta, you may want to use [instrumentation libraries]
(/docs/instrumentation/net/libraries) explicitly instead.

[release]: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/latest
[repo]: https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation
2 changes: 1 addition & 1 deletion content/en/docs/instrumentation/net/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,5 +295,5 @@ Additionally, enriching your codebase with
gives you customized observability data.

You can also check the
[automatic instrumentation for .NET](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation),
[automatic instrumentation for .NET](/docs/instrumentation/net/automatic),
which is currently in beta.
3 changes: 1 addition & 2 deletions content/en/docs/instrumentation/net/libraries.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Using instrumentation libraries
linkTitle: Libraries
aliases: [/docs/instrumentation/net/automatic]
weight: 3
---

Expand Down Expand Up @@ -121,7 +120,7 @@ You'll also want to configure an appropriate exporter to [export your telemetry
data](/docs/instrumentation/net/exporters) to one or more telemetry backends.

You can also check the
[automatic instrumentation for .NET](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation),
[automatic instrumentation for .NET](/docs/instrumentation/net/automatic),
which is currently in beta.

[opentelemetry-dotnet]: https://github.com/open-telemetry/opentelemetry-dotnet
2 changes: 1 addition & 1 deletion content/en/docs/instrumentation/net/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,5 +333,5 @@ You'll also want to configure an appropriate exporter to [export your telemetry
data](/docs/instrumentation/net/exporters) to one or more telemetry backends.

You can also check the
[automatic instrumentation for .NET](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation),
[automatic instrumentation for .NET](/docs/instrumentation/net/automatic),
which is currently in beta.
2 changes: 1 addition & 1 deletion content/en/docs/instrumentation/net/netframework.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,5 +152,5 @@ You'll also want to configure an appropriate exporter to [export your telemetry
data](/docs/instrumentation/net/exporters) to one or more telemetry backends.

You can also check the
[automatic instrumentation for .NET](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation),
[automatic instrumentation for .NET](/docs/instrumentation/net/automatic),
which is currently in beta.

0 comments on commit ea11b25

Please sign in to comment.