Skip to content

Commit dc20104

Browse files
author
Ignacio Bonafonte
authored
Modify README and some experimental statuses (#248)
1 parent cc8d409 commit dc20104

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

Package.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ let package = Package(
2222
.library(name: "libSignPostIntegration", type: .static, targets: ["SignPostIntegration"]),
2323
.library(name: "OpenTracingShim-experimental", type: .static, targets: ["OpenTracingShim"]),
2424
.library(name: "libOpenTracingShim-experimental", type: .static, targets: ["OpenTracingShim"]),
25-
.library(name: "SwiftMetricsShim-experimental", type: .static, targets: ["SwiftMetricsShim"]),
26-
.library(name: "libSwiftMetricsShim-experimental", type: .static, targets: ["SwiftMetricsShim"]),
25+
.library(name: "SwiftMetricsShim", type: .static, targets: ["SwiftMetricsShim"]),
26+
.library(name: "libSwiftMetricsShim", type: .static, targets: ["SwiftMetricsShim"]),
2727
.library(name: "JaegerExporter", type: .static, targets: ["JaegerExporter"]),
2828
.library(name: "libJaegerExporter", type: .static, targets: ["JaegerExporter"]),
2929
.library(name: "ZipkinExporter", type: .static, targets: ["ZipkinExporter"]),
3030
.library(name: "libZipkinExporter", type: .static, targets: ["ZipkinExporter"]),
3131
.library(name: "StdoutExporter", type: .static, targets: ["StdoutExporter"]),
3232
.library(name: "libStdoutExporter", type: .static, targets: ["StdoutExporter"]),
33-
.library(name: "PrometheusExporter-experimental", type: .static, targets: ["PrometheusExporter"]),
34-
.library(name: "libPrometheusExporter-experimental", type: .static, targets: ["PrometheusExporter"]),
33+
.library(name: "PrometheusExporter", type: .static, targets: ["PrometheusExporter"]),
34+
.library(name: "libPrometheusExporter", type: .static, targets: ["PrometheusExporter"]),
3535
.library(name: "OpenTelemetryProtocolExporter", type: .static, targets: ["OpenTelemetryProtocolExporter"]),
3636
.library(name: "libOpenTelemetryProtocolExporter", type: .static, targets: ["OpenTelemetryProtocolExporter"]),
3737
.library(name: "InMemoryExporter", type: .static, targets: ["InMemoryExporter"]),

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,13 @@ This package includes several libraries. The `OpenTelemetryApi` library includes
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-
**Please note** that this library is currently in development, and you should be careful before using in production environments.
1716

1817
#### Adding the dependency
1918

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

2221
```
23-
.package(url: "https://github.com/open-telemetry/opentelemetry-swift", from: "0.6.0"),
22+
.package(url: "https://github.com/open-telemetry/opentelemetry-swift", from: "1.0.0"),
2423
```
2524

2625
and to your application/library target, add `OpenTelemetryApi` or `OpenTelemetrySdk`to your `dependencies`, e.g. like this:
@@ -37,10 +36,9 @@ or
3736

3837
## Current status
3938
<!--Please note:
40-
Tracing spec follows version 1.0.1 and should be considered almost stable now.
41-
Metrics support is experimental, and the spec is still under development.
42-
Semantic Conventions AND OpenTracing shim are also experimental.
43-
Libraries only dependant on these experimental status include the experimental postfix
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.
4442
-->
4543

4644
Currently Tracing, Metrics and Baggage API's and SDK are implemented, also OpenTracing shim, for compatibility with existing Opentracing code.

0 commit comments

Comments
 (0)