Skip to content

Commit 2796cc0

Browse files
authored
chore: Updating root README.md with slack contacts and removing md warnings (#520)
1 parent 613b64d commit 2796cc0

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

README.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,44 @@
1-
# opentelemetry-swift
1+
# <img src="https://opentelemetry.io/img/logos/opentelemetry-logo-nav.png" alt="OpenTelemetry Icon" width="45" height=""> opentelemetry-swift
22

33
[![CI](https://github.com/open-telemetry/opentelemetry-swift/actions/workflows/BuildAndTest.yml/badge.svg)](https://github.com/open-telemetry/opentelemetry-swift/actions/workflows/BuildAndTest.yml?query=branch%3Amain+)
44
[![codecov](https://codecov.io/gh/open-telemetry/opentelemetry-swift/branch/master/graph/badge.svg)](https://codecov.io/gh/open-telemetry/opentelemetry-swift)
55

6+
## About
67

8+
The repository contains the Swift [OpenTelemetry](https://opentelemetry.io/) client
79

8-
A swift [OpenTelemetry](https://opentelemetry.io/) client
9-
10-
## Installation
10+
## Getting Started
1111

1212
This package includes several libraries. The `OpenTelemetryApi` library includes protocols and no-op implementations that comprise the OpenTelemetry API following the [specification](https://github.com/open-telemetry/opentelemetry-specification). The `OpenTelemetrySdk` library is the reference implementation of the API.
1313

1414
Libraries that produce telemetry data should only depend on `OpenTelemetryApi`, and defer the choice of the SDK to the application developer. Applications may depend on `OpenTelemetrySdk` or another package that implements the API.
1515

16-
17-
#### Adding the dependency
16+
### Adding the dependency
1817

1918
opentelemetry-swift is designed for Swift 5. To depend on the opentelemetry-swift package, you need to declare your dependency in your `Package.swift`:
2019

21-
```
20+
```swift
2221
.package(url: "https://github.com/open-telemetry/opentelemetry-swift", from: "1.0.0"),
2322
```
2423

2524
and to your application/library target, add `OpenTelemetryApi` or `OpenTelemetrySdk`to your `dependencies`, e.g. like this:
2625

27-
```
26+
```swift
2827
.target(name: "ExampleTelemetryProducerApp", dependencies: ["OpenTelemetryApi"]),
2928
```
3029

31-
or
30+
or
3231

33-
```
32+
```swift
3433
.target(name: "ExampleApp", dependencies: ["OpenTelemetrySdk"]),
3534
```
3635

3736
## Documentation
3837

3938
Official documentation for the library can be found in the official opentelemetry [documentation page](https://opentelemetry.io/docs/instrumentation/swift/), including:
4039

41-
* Documentation about installation and [manual instrumentation](https://opentelemetry.io/docs/instrumentation/swift/manual/)
42-
40+
* Documentation about installation and [manual instrumentation](https://opentelemetry.io/docs/instrumentation/swift/manual/)
41+
4342
* [Libraries](https://opentelemetry.io/docs/instrumentation/swift/libraries/) that provide automatic instrumentation
4443

4544
## Current status
@@ -55,32 +54,41 @@ Metrics is implemented using an outdated spec, is fully functional but will chan
5554
### Supported exporters and importers
5655

5756
#### Traces
57+
5858
* Exporters: Stdout, Jaeger, Zipkin, Datadog and OpenTelemetry (OTLP) collector
5959
* Importers: OpenTracingShim
6060

61-
#### Metrics
61+
#### Metrics
62+
6263
* Exporters: Prometheus, Datadog, and OpenTelemetry (OTLP) collector
6364
* Importers: SwiftMetricsShim
6465

65-
#### Logs
66+
#### Logs
67+
6668
* Exporters: OpenTelemetry (OTLP) collector
6769

6870
> **_NOTE:_** OTLP exporters are supported both in GRPC and HTTP, only GRPC is production ready, HTTP is still experimental
6971
7072
### Instrumentation libraries
71-
* URLSession
72-
* NetworkStatus
73-
* SDKResourceExtension
74-
* SignPostIntegration
7573

74+
* `URLSession`
75+
* `NetworkStatus`
76+
* `SDKResourceExtension`
77+
* `SignPostIntegration`
7678

7779
## Examples
7880

7981
The package includes some example projects with basic functionality:
8082

81-
- `Datadog Sample` - Shows the Datadog exporter used with a Simple Exporter, showing how to configure for sending.
82-
- `Logging Tracer` - Simple api implementation of a Tracer that logs every api call
83-
- `Network Tracer` - Shows how to use the `URLSessionInstrumentation` instrumentation in your application
84-
- `Simple Exporter` - Shows the Jaeger an Stdout exporters in action using a MultiSpanExporter. Can be easily modified for other exporters
85-
- `Prometheus Sample` - Shows the Prometheus exporter reporting metrics to a Prometheus instance
86-
- `OTLP Exporter` - Shows the OTLP exporter reporting traces to Zipkin and metrics to a Prometheus via the otel-collector
83+
* `Datadog Sample` - Shows the Datadog exporter used with a Simple Exporter, showing how to configure for sending.
84+
* `Logging Tracer` - Simple api implementation of a Tracer that logs every api call
85+
* `Network Tracer` - Shows how to use the `URLSessionInstrumentation` instrumentation in your application
86+
* `Simple Exporter` - Shows the Jaeger an Stdout exporters in action using a MultiSpanExporter. Can be easily modified for other exporters
87+
* `Prometheus Sample` - Shows the Prometheus exporter reporting metrics to a Prometheus instance
88+
* `OTLP Exporter` - Shows the OTLP exporter reporting traces to Zipkin and metrics to a Prometheus via the otel-collector
89+
90+
## Contributing
91+
92+
For an overview of how to contribute, see the contributing guide in [CONTRIBUTING.md](CONTRIBUTING.md).
93+
94+
We are also available in the [#otel-swift](https://cloud-native.slack.com/archives/C01NCHR19SB) channel in the [CNCF slack](https://slack.cncf.io/). Please join us there for further discussions.

0 commit comments

Comments
 (0)