Skip to content

Commit 1b046a7

Browse files
martincostellomartincostello
authored
README updates (#143)
- Fix some invalid HTML. - Move links to not be inline.
1 parent 57b8c2f commit 1b046a7

File tree

1 file changed

+42
-28
lines changed

1 file changed

+42
-28
lines changed

‎README.md

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
<!-- markdownlint-disable -->
1+
# Grafana OpenTelemetry distribution for .NET
2+
3+
<!-- markdownlint-disable MD013 MD033 -->
24
<p>
3-
<img src="internal/img/Grafana_icon.png" alt="Grafana logo" height="70"/ >
4-
<img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry logo" width="70"/ >
5+
<img src="internal/img/Grafana_icon.png" alt="Grafana logo" height="70" />
6+
<img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry logo" width="70" />
57
</p>
6-
<!-- markdownlint-enable -->
7-
8-
# Grafana OpenTelemetry distribution for .NET
8+
<!-- markdownlint-enable MD013 MD033 -->
99

1010
<!-- markdown-link-check-disable -->
11-
[![Build](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/unit-tests.yml)
12-
[![OATS](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml/badge.svg?branch=main)](https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml)
13-
[![NuGet](https://img.shields.io/nuget/v/Grafana.OpenTelemetry?logo=nuget&label=NuGet&color=blue)](https://www.nuget.org/profiles/Grafana)
14-
[![SDK](https://img.shields.io/badge/otel--sdk-1.9.0-blue?style=flat&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-dotnet)
15-
[![Slack](https://img.shields.io/badge/join%20slack-%23app--o11y-brightgreen.svg?logo=slack)](https://grafana.slack.com/archives/C05E87XRK3J)
11+
[![Build][ci-badge]][ci-status]
12+
[![OATS][oats-badge]][oats-status]
13+
[![NuGet][package-badge-version]][package-download]
14+
[![SDK][otel-badge]][otel]
15+
[![Slack][slack-badge]][slack-channel]
1616
<!-- markdown-link-check-enable -->
1717

1818
## About
1919

20-
This is a pre-configured and pre-packaged bundle of [OpenTelemetry .NET components](http://github.com/open-telemetry/opentelemetry-dotnet-contrib),
21-
optimized for [Grafana Cloud Application Observability](https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/).
20+
This is a pre-configured and pre-packaged bundle of [OpenTelemetry .NET components][otel-contrib],
21+
optimized for [Grafana Cloud Application Observability][app-o11y].
2222

2323
It requires only minimal setup and configuration and makes it very easy to emit
2424
OpenTelemetry metrics, logs, and traces from your .NET application.
@@ -28,8 +28,7 @@ OpenTelemetry metrics, logs, and traces from your .NET application.
2828
### Step 1: Install package
2929

3030
For installing the distribution with the full set of dependencies, add a
31-
reference to the [`Grafana.OpenTelemetry`](https://www.nuget.org/packages/Grafana.OpenTelemetry)
32-
package to your project.
31+
reference to the [`Grafana.OpenTelemetry`][package] package to your project.
3332

3433
```sh
3534
dotnet add package Grafana.OpenTelemetry
@@ -39,7 +38,7 @@ dotnet add package Grafana.OpenTelemetry
3938

4039
The `UseGrafana` extension method on the `TracerProviderBuilder` or the
4140
`MetricProviderBuilder` can be used to set up the Grafana distribution. By
42-
default, telemetry data will be sent to Grafana Alloy or an OTel collector
41+
default, telemetry data will be sent to Grafana Alloy or an OpenTelemetry collector
4342
that runs locally and listens to default OTLP ports.
4443

4544
```csharp
@@ -53,9 +52,8 @@ involving an agent or collector. This can be configured via the environment
5352
variables `OTEL_EXPORTER_OTLP_PROTOCOL`, `OTEL_EXPORTER_OTLP_ENDPOINT`, and
5453
`OTEL_EXPORTER_OTLP_HEADERS`.
5554

56-
For details on how to obtain those values, refer to [Push directly from
57-
applications using the OpenTelemetry
58-
SDKs](https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#push-directly-from-applications-using-the-opentelemetry-sdks).
55+
For details on how to obtain those values, refer to
56+
[Send data to the Grafana Cloud OTLP endpoint: Quickstart architecture][push-oltp].
5957

6058
```sh
6159
export OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf"
@@ -76,10 +74,9 @@ documents:
7674

7775
## Troubleshooting
7876

79-
This project utilizes the [self-diagnostics feature of the .NET OpenTelemetry SDK](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry/README.md#self-diagnostics).
77+
This project utilizes the [self-diagnostics feature of the .NET OpenTelemetry SDK][self-diagnostics].
8078

81-
To enable self-diagnostics, go to the
82-
[current working directory](https://en.wikipedia.org/wiki/Working_directory) of
79+
To enable self-diagnostics, go to the [current working directory][working-dir] of
8380
your process and create a configuration file named `OTEL_DIAGNOSTICS.json` with
8481
the following content:
8582

@@ -98,9 +95,26 @@ To disable self-diagnostics, delete the above file.
9895
To engage with the Grafana Application Observability community:
9996

10097
* Chat with us on our community Slack channel. To invite yourself to the
101-
Grafana Slack, visit [https://grafana.slack.com/](https://grafana.slack.com)
102-
and join the [#application-observability](https://grafana.slack.com/archives/C05E87XRK3J)
103-
channel.
104-
* Ask questions on the [Discussions page](https://github.com/grafana/grafana-opentelemetry-dotnet/discussions).
105-
* [File an issue](https://github.com/grafana/grafana-opentelemetry-dotnet/issues/new)
106-
for bugs, issues, and feature suggestions.
98+
Grafana Slack, visit <https://grafana.slack.com>
99+
and join the [#application-observability][slack-channel] channel.
100+
* Ask questions on the [Discussions page][discussions].
101+
* [File an issue][issues] for bugs, issues, and feature suggestions.
102+
103+
[app-o11y]: https://grafana.com/docs/grafana-cloud/monitor-applications/application-observability/
104+
[ci-badge]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/unit-tests.yml/badge.svg?branch=main
105+
[ci-status]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/unit-tests.yml
106+
[discussions]: https://github.com/grafana/grafana-opentelemetry-dotnet/discussions
107+
[issues]: https://github.com/grafana/grafana-opentelemetry-dotnet/issues/new
108+
[oats-badge]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml/badge.svg?branch=main
109+
[oats-status]: https://github.com/grafana/grafana-opentelemetry-dotnet/actions/workflows/oats.yml
110+
[otel]: https://github.com/open-telemetry/opentelemetry-dotnet
111+
[otel-badge]: https://img.shields.io/badge/OTel--SDK-1.9.0-blue?style=flat&logo=opentelemetry
112+
[otel-contrib]: http://github.com/open-telemetry/opentelemetry-dotnet-contrib
113+
[package]: https://www.nuget.org/packages/Grafana.OpenTelemetry
114+
[package-badge-version]: https://img.shields.io/nuget/v/Grafana.OpenTelemetry?logo=nuget&label=NuGet&color=blue
115+
[package-download]: https://www.nuget.org/profiles/Grafana
116+
[push-oltp]: https://grafana.com/docs/grafana-cloud/send-data/otlp/send-data-otlp/#quickstart-architecture
117+
[self-diagnostics]: https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry/README.md#self-diagnostics
118+
[slack-badge]: https://img.shields.io/badge/%20Slack-%23app--o11y-brightgreen.svg?logo=slack
119+
[slack-channel]: https://grafana.slack.com/archives/C05E87XRK3J
120+
[working-dir]: https://en.wikipedia.org/wiki/Working_directory

0 commit comments

Comments
 (0)