Merge branch 'main' into profiling

open-telemetry · Jul 26, 2023 · d3b7479 · d3b7479
2 parents 8cd1e60 + 81a296f
commit d3b7479
Show file tree

Hide file tree

Showing 10 changed files with 641 additions and 30 deletions.
diff --git a/.github/workflows/build-check.yaml b/.github/workflows/build-check.yaml
@@ -111,3 +111,15 @@ jobs:
 
     - name: run markdown-link-check
       run: make markdown-link-check
+
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+    - name: check out code
+      uses: actions/checkout@v2
+
+    - name: install dependencies
+      run: npm install
+
+    - name: run markdownlint
+      run: make markdownlint
diff --git a/.markdown_link_check_config.json b/.markdown_link_check_config.json
@@ -6,8 +6,12 @@
   ],
   "replacementPatterns": [
     {
-        "pattern": "^/",
-        "replacement": "{{BASEURL}}/"
+      "pattern": "^/",
+      "replacement": "{{BASEURL}}/"
+    },
+    {
+      "pattern": "^https://github.com/open-telemetry/opentelemetry-proto/(blob|tree)/[^/]+/docs/",
+      "replacement": "LINK-CHECK-ERROR-USE-LOCAL-PATH-TO-DOC-PAGE-NOT-EXTERNAL-URL/"
     }
   ],
   "retryOn429": true,

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,14 @@
+# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
+# and https://github.com/DavidAnson/markdownlint/blob/main/README.md
+
+# Default state for all rules
+default: true
+
+ul-style: false
+line-length: false
+no-duplicate-header:
+  siblings_only: true
+ol-prefix:
+  style: ordered
+no-inline-html: false
+fenced-code-language: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,18 @@
 
 ## Unreleased
 
-Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.20.0...main).
+Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v1.0.0...main).
+
+## 1.0.0 - 2023-07-03
+
+Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.20.0...v1.0.0).
+
+### Maturity
+
+* Add note about the possibility to have unstable components after 1.0.0
+  [#489](https://github.com/open-telemetry/opentelemetry-proto/pull/489)
+* Add maturity JSON entry per package
+  [#490](https://github.com/open-telemetry/opentelemetry-proto/pull/490)
 
 ## 0.20.0 - 2023-06-06
 
@@ -47,7 +58,7 @@ Full list of differences found in [this compare](https://github.com/open-telemet
 * Add `csharp_namespace` option to protos.
   ([#399](https://github.com/open-telemetry/opentelemetry-proto/pull/399))
 * Fix some out-of-date urls which link to [specification](https://github.com/open-telemetry/opentelemetry-specification). ([#402](https://github.com/open-telemetry/opentelemetry-proto/pull/402))
-* :stop_sign: [BREAKING] Delete deprecated InstrumentationLibrary, 
+* :stop_sign: [BREAKING] Delete deprecated InstrumentationLibrary,
   InstrumentationLibraryLogs, InstrumentationLibrarySpans and
   InstrumentationLibraryMetrics messages. Delete deprecated
   instrumentation_library_logs, instrumentation_library_spans and
@@ -126,7 +137,7 @@ Full list of differences found in [this compare](https://github.com/open-telemet
 
 * Remove unused deprecated message StringKeyValue (#358)
 * Remove experimental metrics config service (#359)
- 
+
 ## 0.12.0 - 2022-01-19
 
 Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.11.0...v0.12.0).
@@ -277,9 +288,9 @@ Full list of differences found in [this compare.](https://github.com/open-teleme
 ### Changed
 
 * :stop_sign: [BREAKING] Metrics - protocol was refactored, and lots of breaking changes.
-** Removed MetricDescriptor and embedded into Metric and the new data types.
-** Add new data types Gauge/Sum/Histogram.
-** Make use of the "AggregationTemporality" into the data types that allow that support.
+  * Removed MetricDescriptor and embedded into Metric and the new data types.
+  * Add new data types Gauge/Sum/Histogram.
+  * Make use of the "AggregationTemporality" into the data types that allow that support.
 * Rename enum values to follow the proto3 style guide.
 
 ### Added

diff --git a/Makefile b/Makefile
@@ -14,7 +14,7 @@ $(1)
 endef
 
 .PHONY: all
-all: gen-all markdown-link-check
+all: gen-all markdown-link-check markdownlint
 
 # Generate all implementations
 .PHONY: gen-all
@@ -165,3 +165,12 @@ markdown-link-check:
 		npx --no -- markdown-link-check --quiet --config .markdown_link_check_config.json $$f \
 			|| exit 1; \
 	done
+
+.PHONY: markdownlint
+markdownlint:
+	@if ! npm ls markdownlint; then npm install; fi
+	@for f in $(ALL_DOCS); do \
+		echo $$f; \
+		npx --no -p markdownlint-cli markdownlint -c .markdownlint.yaml $$f \
+			|| exit 1; \
+	done
diff --git a/README.md b/README.md
@@ -33,16 +33,16 @@ To generate the raw gRPC client libraries, use `make gen-${LANGUAGE}`. Currently
 
 ## Maturity Level
 
-Component                            | Maturity                                                                                                                                |
--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
-**Binary Protobuf Encoding**         |                                                                                                                                         |
-common/*                             | Stable                                                                                                                                  |
-metrics/\*<br>collector/metrics/*    | Stable                                                                                                                                  |
-resource/*                           | Stable                                                                                                                                  |
-trace/\*<br>collector/trace/* | Stable                                                                                                                                  |
-logs/\*<br>collector/logs/*          | Stable                                                                                                                                  |
-**JSON encoding**                    |                                                                                                                                         |
-All messages                         | [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#json-protobuf-encoding) |
+1.0.0 and newer releases from this repository may contain unstable (alpha or beta)
+components as indicated by the Maturity table below.
+
+| Component | Binary Protobuf Maturity | JSON Maturity |
+| --------- |--------------- | ------------- |
+| common/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) |
+| resource/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) |
+| metrics/\*<br>collector/metrics/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) |
+| trace/\*<br>collector/trace/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) |
+| logs/\*<br>collector/logs/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) |
 
 (See [maturity-matrix.yaml](https://github.com/open-telemetry/community/blob/47813530864b9fe5a5146f466a58bd2bb94edc72/maturity-matrix.yaml#L57)
 for definition of maturity levels).

diff --git a/docs/specification.md b/docs/specification.md
@@ -169,7 +169,7 @@ If the server receives an empty request (a request that does not carry
 any telemetry data) the server SHOULD respond with success.
 
 On success, the server response MUST be a
-[Export<signal>ServiceResponse](../opentelemetry/proto/collector)
+[Export\<signal>ServiceResponse](../opentelemetry/proto/collector)
 message (`ExportTraceServiceResponse` for traces,
 `ExportMetricsServiceResponse` for metrics and
 `ExportLogsServiceResponse` for logs).
@@ -182,7 +182,7 @@ in case of a successful response.
 If the request is only partially accepted
 (i.e. when the server accepts only parts of the data and rejects the rest), the
 server response MUST be the same
-[Export<signal>ServiceResponse](../opentelemetry/proto/collector)
+[Export\<signal>ServiceResponse](../opentelemetry/proto/collector)
 message as in the [Full Success](#full-success) case.
 
 Additionally, the server MUST initialize the `partial_success` field
@@ -492,7 +492,7 @@ If the server receives an empty request (a request that does not carry
 any telemetry data) the server SHOULD respond with success.
 
 On success, the server MUST respond with `HTTP 200 OK`. The response body MUST be
-a Protobuf-encoded [Export<signal>ServiceResponse](../opentelemetry/proto/collector)
+a Protobuf-encoded [Export\<signal>ServiceResponse](../opentelemetry/proto/collector)
 message (`ExportTraceServiceResponse` for traces,
 `ExportMetricsServiceResponse` for metrics and
 `ExportLogsServiceResponse` for logs).
@@ -505,7 +505,7 @@ in case of a successful response.
 If the request is only partially accepted
 (i.e. when the server accepts only parts of the data and rejects the rest), the
 server MUST respond with `HTTP 200 OK`. The response body MUST be the same
-[Export<signal>ServiceResponse](../opentelemetry/proto/collector)
+[Export\<signal>ServiceResponse](../opentelemetry/proto/collector)
 message as in the [Full Success](#full-success-1) case.
 
 Additionally, the server MUST initialize the `partial_success` field

diff --git a/examples/metrics.json b/examples/metrics.json
@@ -29,7 +29,7 @@
             {
               "name": "my.counter",
               "unit": "1",
-              "description": "I'm a Counter",
+              "description": "I am a Counter",
               "sum": {
                 "aggregationTemporality": 1,
                 "isMonotonic": true,
@@ -53,7 +53,7 @@
             {
               "name": "my.gauge",
               "unit": "1",
-              "description": "I'm a Gauge",
+              "description": "I am a Gauge",
               "gauge": {
                 "dataPoints": [
                   {
@@ -74,7 +74,7 @@
             {
               "name": "my.histogram",
               "unit": "1",
-              "description": "I'm a Histogram",
+              "description": "I am a Histogram",
               "histogram": {
                 "aggregationTemporality": 1,
                 "dataPoints": [
@@ -104,4 +104,4 @@
       ]
     }
   ]
-}
+}