Skip to content

Commit 610b0d4

Browse files
author
Ignacio Bonafonte
authored
Update README document with updated documentation (#346)
* Update README document
1 parent e45046d commit 610b0d4

File tree

1 file changed

+30
-8
lines changed

1 file changed

+30
-8
lines changed

README.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,40 @@ or
3434
.target(name: "ExampleApp", dependencies: ["OpenTelemetrySdk"]),
3535
```
3636

37+
## Documentation
38+
39+
Official documentation for the library can be found in the official opentelemetry [documentation page](https://opentelemetry.io/docs/instrumentation/swift/), including:
40+
41+
* Documentation about installation and [manual instrumentation](https://opentelemetry.io/docs/instrumentation/swift/manual/)
42+
43+
* [Libraries](https://opentelemetry.io/docs/instrumentation/swift/libraries/) that provide automatic instrumentation
44+
3745
## Current status
38-
<!--Please note:
39-
Tracing spec follows version 1.0.1 and should be considered stable.
40-
Metrics support is in beta, and the spec is still not following latest approved spec.
41-
Semantic Conventions and OpenTracing shim are also experimental.
42-
-->
4346

44-
Currently Tracing, Metrics and Baggage API's and SDK are implemented, also OpenTracing shim, for compatibility with existing Opentracing code.
47+
### API and SDK
48+
49+
Tracing and Baggage should be considered stable
50+
51+
Metrics is implemented using an outdated spec, is fully functional but will change in the future
52+
53+
Logs are currently in development
54+
55+
### Supported exporters, importers and instrumentation libraries
56+
57+
#### Traces
58+
* Exporters: Stdout, Jaeger, Zipkin, Datadog and OpenTelemetry (OTLP) collector
59+
* Importers: OpenTracingShim
60+
61+
#### Metrics
62+
* Exporters: Prometheus, Datadog, and OpenTelemetry (OTLP) collector
63+
* Importers: SwiftMetricsShim
4564

46-
Implemented traces exporters: Stdout, Jaeger, Zipkin, Datadog and OpenTelemetry collector
65+
#### Instrumentation libraries
66+
* URLSession
67+
* NetworkStatus
68+
* SDKResourceExtension
69+
* SignPostIntegration
4770

48-
Implemented metrics exporters: Prometheus, Datadog, and OpenTelemetry collector
4971

5072
## Examples
5173

0 commit comments

Comments
 (0)