From 5c3d49a537443a7191a797fbf00d0afe6b222b33 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Tue, 5 Dec 2023 03:51:59 -0500 Subject: [PATCH 01/19] Update semantic-conventions.md adding link to logs (#3648) --- content/en/docs/concepts/semantic-conventions.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/en/docs/concepts/semantic-conventions.md b/content/en/docs/concepts/semantic-conventions.md index 545e22c09ceb..3a24bea93708 100644 --- a/content/en/docs/concepts/semantic-conventions.md +++ b/content/en/docs/concepts/semantic-conventions.md @@ -6,12 +6,13 @@ weight: 30 OpenTelemetry defines [Semantic Conventions](/docs/specs/semconv/) (sometimes called Semantic Attributes) that specify common names for different kinds of -operations and data. The benefit to using Semantic Conventions is in following a +operations and data. The benefit of using Semantic Conventions is in following a common naming scheme that can be standardized across a codebase, libraries, and platforms. -Currently, Semantic Conventions are available for traces, metrics and resources: +Semantic Conventions are available for traces, metrics, logs, and resources: - [Trace Semantic Conventions](/docs/specs/semconv/general/trace/) - [Metric Semantic Conventions](/docs/specs/semconv/general/metrics/) +- [Log Semantic Conventions](/docs/specs/semconv/general/logs/) - [Resource Semantic Conventions](/docs/specs/semconv/resource/) From 330bf55439fcda067f5694d7f50fac98d4defdad Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Tue, 5 Dec 2023 11:54:34 +0100 Subject: [PATCH 02/19] Registry Updates December 2023 (#3630) --- .../collector-exporter-alertmanager.yml | 18 +++++++ ...quet.yml => collector-extension-opamp.yml} | 12 ++--- .../collector-extension-remotetap.yml | 16 ++++++ ....yml => collector-processor-remotetap.yml} | 9 ++-- .../collector-processor-sumologic.yml | 17 ++++++ data/registry/exporter-python-jaeger.yml | 12 ----- .../exporter-python-jaegerprotogrpc.yml | 16 ------ .../registry/exporter-python-jaegerthrift.yml | 14 ----- data/registry/instrumentation-go-beego.yml | 16 ++++++ .../instrumentation-go-go-restful.yml | 14 ----- data/registry/instrumentation-go-gocql.yml | 15 ++++++ .../instrumentation-go-gomemcache.yml | 16 ++++++ data/registry/instrumentation-go-http.yml | 16 ++++++ data/registry/instrumentation-go-macaron.yml | 14 ----- data/registry/instrumentation-go-mongodb.yml | 7 ++- ...lla-mux.yml => instrumentation-go-mux.yml} | 8 +-- data/registry/instrumentation-go-net-http.yml | 16 ------ ...aws.yml => instrumentation-go-otelaws.yml} | 2 +- data/registry/instrumentation-go-otelkit.yml | 14 +++++ ....yml => instrumentation-go-otellambda.yml} | 7 +-- .../instrumentation-go-otelmacaron.yml | 14 +++++ data/registry/instrumentation-go-restful.yml | 16 ++++++ data/registry/instrumentation-go-sarama.yml | 15 ++++++ data/registry/instrumentation-php-yii.yml | 12 +++++ .../instrumentation-python-aiohttpserver.yml | 17 ++++++ data/registry/instrumentation-ruby-httpx.yml | 16 ++++++ data/registry/resource-detector-js-azure.yml | 13 +++++ static/refcache.json | 52 +++++++++++++++++++ 28 files changed, 308 insertions(+), 106 deletions(-) create mode 100644 data/registry/collector-exporter-alertmanager.yml rename data/registry/{collector-exporter-parquet.yml => collector-extension-opamp.yml} (53%) create mode 100644 data/registry/collector-extension-remotetap.yml rename data/registry/{collector-processor-remoteobserver.yml => collector-processor-remotetap.yml} (69%) create mode 100644 data/registry/collector-processor-sumologic.yml delete mode 100644 data/registry/exporter-python-jaeger.yml delete mode 100644 data/registry/exporter-python-jaegerprotogrpc.yml delete mode 100644 data/registry/exporter-python-jaegerthrift.yml create mode 100644 data/registry/instrumentation-go-beego.yml delete mode 100644 data/registry/instrumentation-go-go-restful.yml create mode 100644 data/registry/instrumentation-go-gocql.yml create mode 100644 data/registry/instrumentation-go-gomemcache.yml create mode 100644 data/registry/instrumentation-go-http.yml delete mode 100644 data/registry/instrumentation-go-macaron.yml rename data/registry/{instrumentation-go-gorilla-mux.yml => instrumentation-go-mux.yml} (52%) delete mode 100644 data/registry/instrumentation-go-net-http.yml rename data/registry/{instrumentation-go-aws.yml => instrumentation-go-otelaws.yml} (65%) create mode 100644 data/registry/instrumentation-go-otelkit.yml rename data/registry/{instrumentation-go-lambda.yml => instrumentation-go-otellambda.yml} (80%) create mode 100644 data/registry/instrumentation-go-otelmacaron.yml create mode 100644 data/registry/instrumentation-go-restful.yml create mode 100644 data/registry/instrumentation-go-sarama.yml create mode 100644 data/registry/instrumentation-php-yii.yml create mode 100644 data/registry/instrumentation-python-aiohttpserver.yml create mode 100644 data/registry/instrumentation-ruby-httpx.yml create mode 100644 data/registry/resource-detector-js-azure.yml diff --git a/data/registry/collector-exporter-alertmanager.yml b/data/registry/collector-exporter-alertmanager.yml new file mode 100644 index 000000000000..b863182dd41d --- /dev/null +++ b/data/registry/collector-exporter-alertmanager.yml @@ -0,0 +1,18 @@ +# cSpell:ignore alertmanager +title: Alertmanager Exporter +registryType: exporter +isThirdParty: false +language: collector +tags: + - alertmanager + - prometheus + - exporter + - collector +repo: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/alertmanagerexporter +license: Apache 2.0 +description: + Exports OTel Events (SpanEvent in Tracing added by AddEvent API) as Alerts to + [Alertmanager] (https://prometheus.io/docs/alerting/latest/alertmanager/) + back-end to notify Errors or Change events. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/collector-exporter-parquet.yml b/data/registry/collector-extension-opamp.yml similarity index 53% rename from data/registry/collector-exporter-parquet.yml rename to data/registry/collector-extension-opamp.yml index 9fc173d5894e..f5912543fd64 100644 --- a/data/registry/collector-exporter-parquet.yml +++ b/data/registry/collector-extension-opamp.yml @@ -1,13 +1,13 @@ -title: Parquet File Exporter -registryType: exporter +title: OpAMP Agent Extension +registryType: extension isThirdParty: false language: collector tags: - - go - - exporter + - opamp + - extension - collector -repo: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/parquetexporter +repo: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/opampextension license: Apache 2.0 -description: Sends pipeline data to Parquet files. +description: Collector extension for OpAMP authors: OpenTelemetry Authors otVersion: latest diff --git a/data/registry/collector-extension-remotetap.yml b/data/registry/collector-extension-remotetap.yml new file mode 100644 index 000000000000..b02789cd9dd5 --- /dev/null +++ b/data/registry/collector-extension-remotetap.yml @@ -0,0 +1,16 @@ +title: Remote Tap Extension +registryType: extension +isThirdParty: false +language: collector +tags: + - remote + - tap + - extension + - collector +repo: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/remotetapextension +license: Apache 2.0 +description: + This extension runs as a Web server that loads the remote observers that are + registered against it. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/collector-processor-remoteobserver.yml b/data/registry/collector-processor-remotetap.yml similarity index 69% rename from data/registry/collector-processor-remoteobserver.yml rename to data/registry/collector-processor-remotetap.yml index 5462caa4eb6c..5d46716dff04 100644 --- a/data/registry/collector-processor-remoteobserver.yml +++ b/data/registry/collector-processor-remotetap.yml @@ -3,14 +3,15 @@ registryType: processor isThirdParty: false language: collector tags: - - remoteobserver + - websocket + - remote + - tap - processor - collector -repo: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/remoteobserverprocessor +repo: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/remotetapprocessor license: Apache 2.0 description: The WebSocket processor, which can be positioned anywhere in a pipeline, - allows data to pass through to the next component. + allows authors: OpenTelemetry Authors otVersion: latest -# cSpell:ignore remoteobserver diff --git a/data/registry/collector-processor-sumologic.yml b/data/registry/collector-processor-sumologic.yml new file mode 100644 index 000000000000..bc87f0b0ce43 --- /dev/null +++ b/data/registry/collector-processor-sumologic.yml @@ -0,0 +1,17 @@ +# cspell:ignore sumologic +title: Sumo Logic Processor +registryType: processor +isThirdParty: false +language: collector +tags: + - sumologic + - processor + - collector +repo: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/sumologicprocessor +license: Apache 2.0 +description: + The Sumo Logic processor modifies the metadata on logs, metrics and traces + sent to Sumo Logic so that the Sumo Logic apps can make full use of the + ingested data. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/exporter-python-jaeger.yml b/data/registry/exporter-python-jaeger.yml deleted file mode 100644 index 8b65011d0790..000000000000 --- a/data/registry/exporter-python-jaeger.yml +++ /dev/null @@ -1,12 +0,0 @@ -title: Jaeger Exporter -registryType: exporter -isThirdParty: false -language: python -tags: - - python - - exporter -repo: https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-jaeger -license: Apache 2.0 -description: The OpenTelemetry Jaeger Exporter for Python. -authors: OpenTelemetry Authors -otVersion: latest diff --git a/data/registry/exporter-python-jaegerprotogrpc.yml b/data/registry/exporter-python-jaegerprotogrpc.yml deleted file mode 100644 index e44a271bcf34..000000000000 --- a/data/registry/exporter-python-jaegerprotogrpc.yml +++ /dev/null @@ -1,16 +0,0 @@ -# cSpell:ignore -title: OpenTelemetry Jaeger protobuf Exporter -registryType: exporter -isThirdParty: false -language: python -tags: - - jaeger - - protobuf - - grpc - - exporter - - python -repo: https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-jaeger-proto-grpc -license: Apache 2.0 -description: This library allows to export tracing data to Jaeger. -authors: OpenTelemetry Authors -otVersion: latest diff --git a/data/registry/exporter-python-jaegerthrift.yml b/data/registry/exporter-python-jaegerthrift.yml deleted file mode 100644 index b4899c4e6232..000000000000 --- a/data/registry/exporter-python-jaegerthrift.yml +++ /dev/null @@ -1,14 +0,0 @@ -title: OpenTelemetry Jaeger Thrift Exporter -registryType: exporter -isThirdParty: false -language: python -tags: - - jaeger - - thrift - - exporter - - python -repo: https://github.com/open-telemetry/opentelemetry-python/tree/main/exporter/opentelemetry-exporter-jaeger-thrift -license: Apache 2.0 -description: This library allows to export tracing data to Jaeger using Thrift. -authors: OpenTelemetry Authors -otVersion: latest diff --git a/data/registry/instrumentation-go-beego.yml b/data/registry/instrumentation-go-beego.yml new file mode 100644 index 000000000000..cf64c47c9a0b --- /dev/null +++ b/data/registry/instrumentation-go-beego.yml @@ -0,0 +1,16 @@ +# cSpell:ignore beego astaxie +title: Beego Instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - beego + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego +license: Apache 2.0 +description: + Package beego provides functions to instrument the github.com/astaxie/beego + package. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-go-go-restful.yml b/data/registry/instrumentation-go-go-restful.yml deleted file mode 100644 index ffc6e373b753..000000000000 --- a/data/registry/instrumentation-go-go-restful.yml +++ /dev/null @@ -1,14 +0,0 @@ -# cSpell:ignore emicklei -title: Go-restful Instrumentation -registryType: instrumentation -isThirdParty: false -language: go -tags: - - go - - instrumentation - - http -repo: https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/github.com/emicklei/go-restful -license: Apache 2.0 -description: Go contrib plugin for the emicklei/go-restful package. -authors: OpenTelemetry Authors -otVersion: latest diff --git a/data/registry/instrumentation-go-gocql.yml b/data/registry/instrumentation-go-gocql.yml new file mode 100644 index 000000000000..73d25df07d68 --- /dev/null +++ b/data/registry/instrumentation-go-gocql.yml @@ -0,0 +1,15 @@ +# cSpell:ignore gocql +title: gocql Instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - gocql + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql +license: Apache 2.0 +description: + Package gocql provides functions to instrument the gocql/gocql package. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-go-gomemcache.yml b/data/registry/instrumentation-go-gomemcache.yml new file mode 100644 index 000000000000..1f41e78ae4f1 --- /dev/null +++ b/data/registry/instrumentation-go-gomemcache.yml @@ -0,0 +1,16 @@ +# cSpell:ignore gomemcache +title: gomemcache Instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - memcache + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache +license: Apache 2.0 +description: + Package `gomemcache` provides tracing instrumentation for the memcached + client. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-go-http.yml b/data/registry/instrumentation-go-http.yml new file mode 100644 index 000000000000..0992dbcb1974 --- /dev/null +++ b/data/registry/instrumentation-go-http.yml @@ -0,0 +1,16 @@ +title: Go package `net/http` instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - http + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/net/http +license: Apache 2.0 +description: + Package `http` provides a `http.Handler` and functions that are intended to be + used to add tracing by wrapping existing handlers (with Handler) and routes + WithRouteTag. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-go-macaron.yml b/data/registry/instrumentation-go-macaron.yml deleted file mode 100644 index 098400ee4f1f..000000000000 --- a/data/registry/instrumentation-go-macaron.yml +++ /dev/null @@ -1,14 +0,0 @@ -# cSpell:ignore macaron gopkg -title: Macaron Instrumentation -registryType: instrumentation -isThirdParty: false -language: go -tags: - - go - - instrumentation - - http -repo: https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/gopkg.in/macaron.v1 -license: Apache 2.0 -description: Go contrib plugin for the gopkg.in/macaron.v1 package. -authors: OpenTelemetry Authors -otVersion: latest diff --git a/data/registry/instrumentation-go-mongodb.yml b/data/registry/instrumentation-go-mongodb.yml index 53a3a901af39..5f0037670ed8 100644 --- a/data/registry/instrumentation-go-mongodb.yml +++ b/data/registry/instrumentation-go-mongodb.yml @@ -7,8 +7,11 @@ tags: - instrumentation - mongodb - database -repo: https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/go.mongodb.org/mongo-driver +repo: https://go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver license: Apache 2.0 -description: Go contrib plugin for the go.mongodb.org/mongo-driver package. +description: + Package mongo-driver provides functions to trace the + go.mongodb.org/mongo-driver/mongo(https://github.com/mongodb/mongo-go-driver) + package. authors: OpenTelemetry Authors otVersion: latest diff --git a/data/registry/instrumentation-go-gorilla-mux.yml b/data/registry/instrumentation-go-mux.yml similarity index 52% rename from data/registry/instrumentation-go-gorilla-mux.yml rename to data/registry/instrumentation-go-mux.yml index 9f4784a655cc..149174749d28 100644 --- a/data/registry/instrumentation-go-gorilla-mux.yml +++ b/data/registry/instrumentation-go-mux.yml @@ -3,11 +3,11 @@ registryType: instrumentation isThirdParty: false language: go tags: - - go + - mux - instrumentation - - http -repo: https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/github.com/gorilla/mux + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux license: Apache 2.0 -description: Go contrib plugin for the gorilla/mux package. +description: Package mux provides functions to trace the gorilla/mux package authors: OpenTelemetry Authors otVersion: latest diff --git a/data/registry/instrumentation-go-net-http.yml b/data/registry/instrumentation-go-net-http.yml deleted file mode 100644 index 72488f46caa1..000000000000 --- a/data/registry/instrumentation-go-net-http.yml +++ /dev/null @@ -1,16 +0,0 @@ -title: Go package `net/http` instrumentation -registryType: instrumentation -isThirdParty: false -language: go -tags: - - go - - instrumentation - - http - - trace -repo: https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/net/http -license: Apache 2.0 -description: - Go contrib plugin for trace instrumentation of `net/http` handlers, HTTP - transports and HTTP trace events -authors: OpenTelemetry Authors -otVersion: latest diff --git a/data/registry/instrumentation-go-aws.yml b/data/registry/instrumentation-go-otelaws.yml similarity index 65% rename from data/registry/instrumentation-go-aws.yml rename to data/registry/instrumentation-go-otelaws.yml index 300d24bf007c..130e30746a7c 100644 --- a/data/registry/instrumentation-go-aws.yml +++ b/data/registry/instrumentation-go-otelaws.yml @@ -6,7 +6,7 @@ tags: - aws - instrumentation - go -repo: https://github.com/open-telemetry/opentelemetry-go-contrib/tree/main/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws license: Apache 2.0 description: AWS SDK V2 for Go instrumentation authors: OpenTelemetry Authors diff --git a/data/registry/instrumentation-go-otelkit.yml b/data/registry/instrumentation-go-otelkit.yml new file mode 100644 index 000000000000..543ad128a77c --- /dev/null +++ b/data/registry/instrumentation-go-otelkit.yml @@ -0,0 +1,14 @@ +# cspell:ignore otelkit +title: go-kit Instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - kit + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/go-kit/kit/otelkit +license: Apache 2.0 +description: Package otelkit instruments the github.com/go-kit/kit package. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-go-lambda.yml b/data/registry/instrumentation-go-otellambda.yml similarity index 80% rename from data/registry/instrumentation-go-lambda.yml rename to data/registry/instrumentation-go-otellambda.yml index 4eec55e33498..41d28eb7b7f5 100644 --- a/data/registry/instrumentation-go-lambda.yml +++ b/data/registry/instrumentation-go-otellambda.yml @@ -1,10 +1,11 @@ -# cSpell:ignore otellambda -title: otellambda +# cspell:ignore otellambda +title: aws-lambda-go Instrumentation registryType: instrumentation isThirdParty: false language: go tags: - - otellambda + - lambda + - aws - instrumentation - go repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda diff --git a/data/registry/instrumentation-go-otelmacaron.yml b/data/registry/instrumentation-go-otelmacaron.yml new file mode 100644 index 000000000000..75255b8a655d --- /dev/null +++ b/data/registry/instrumentation-go-otelmacaron.yml @@ -0,0 +1,14 @@ +# cSpell:ignore otelmacaron macaron gopkg +title: Macaron Instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - macaron + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron +license: Apache 2.0 +description: Package otelmacaron instruments gopkg.in/macaron.v1. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-go-restful.yml b/data/registry/instrumentation-go-restful.yml new file mode 100644 index 000000000000..eabc943aaf94 --- /dev/null +++ b/data/registry/instrumentation-go-restful.yml @@ -0,0 +1,16 @@ +# cspell:ignore emicklei +title: Go-restful Instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - restful + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/emicklei/go-restful +license: Apache 2.0 +description: + Package go-restful provides functions to trace the emicklei/go-restful/v3 + package. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-go-sarama.yml b/data/registry/instrumentation-go-sarama.yml new file mode 100644 index 000000000000..96e42fe9eb09 --- /dev/null +++ b/data/registry/instrumentation-go-sarama.yml @@ -0,0 +1,15 @@ +# cSpell:ignore sarama +title: Shopify/sarama Instrumentation +registryType: instrumentation +isThirdParty: false +language: go +tags: + - sarama + - instrumentation + - go +repo: https://go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama +license: Apache 2.0 +description: + Package sarama provides functions to trace the Shopify/sarama package. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-php-yii.yml b/data/registry/instrumentation-php-yii.yml new file mode 100644 index 000000000000..0a6cbd8117ca --- /dev/null +++ b/data/registry/instrumentation-php-yii.yml @@ -0,0 +1,12 @@ +title: OpenTelemetry Yii auto-instrumentation +registryType: instrumentation +isThirdParty: false +language: php +tags: + - yii + - instrumentation + - php +repo: https://github.com/open-telemetry/opentelemetry-php-contrib/tree/main/src/Instrumentation/Yii +description: Instrumentation Library for Yii +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-python-aiohttpserver.yml b/data/registry/instrumentation-python-aiohttpserver.yml new file mode 100644 index 000000000000..4340c6e769f5 --- /dev/null +++ b/data/registry/instrumentation-python-aiohttpserver.yml @@ -0,0 +1,17 @@ +# cSpell:ignore aiohttp +title: OpenTelemetry aiohttp server Integration +registryType: instrumentation +isThirdParty: false +language: python +tags: + - aio + - http + - server + - instrumentation + - python +repo: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-aiohttp-server +license: Apache 2.0 +description: + This library allows tracing HTTP requests made by the aiohttp server library. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/instrumentation-ruby-httpx.yml b/data/registry/instrumentation-ruby-httpx.yml new file mode 100644 index 000000000000..c6b9e926e60b --- /dev/null +++ b/data/registry/instrumentation-ruby-httpx.yml @@ -0,0 +1,16 @@ +# cSpell:ignore httpx +title: OpenTelemetry HTTPX Instrumentation +registryType: instrumentation +isThirdParty: false +language: ruby +tags: + - httpx + - instrumentation + - ruby +repo: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/httpx +license: Apache 2.0 +description: + The HTTPX instrumentation is a community-maintained instrumentation for the + HTTPX gem. +authors: OpenTelemetry Authors +otVersion: latest diff --git a/data/registry/resource-detector-js-azure.yml b/data/registry/resource-detector-js-azure.yml new file mode 100644 index 000000000000..ab321f01215e --- /dev/null +++ b/data/registry/resource-detector-js-azure.yml @@ -0,0 +1,13 @@ +title: OpenTelemetry Resource Detector for Azure +registryType: resource-detector +isThirdParty: false +language: js +tags: + - azure + - resource-detector + - js +repo: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-azure +license: Apache 2.0 +description: Resource detector for Azure +authors: OpenTelemetry Authors +otVersion: latest diff --git a/static/refcache.json b/static/refcache.json index e0d50e08adc9..5fe8e4f0e55a 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -2483,6 +2483,10 @@ "StatusCode": 200, "LastSeen": "2023-06-30T08:33:43.877176-04:00" }, + "https://github.com/mongodb/mongo-go-driver": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:51.932405+01:00" + }, "https://github.com/mtwo": { "StatusCode": 200, "LastSeen": "2023-06-30T09:26:09.367602-04:00" @@ -3927,10 +3931,54 @@ "StatusCode": 200, "LastSeen": "2023-07-26T16:44:54.45764-04:00" }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:54.37261+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:49.351999+01:00" + }, "https://go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda": { "StatusCode": 200, "LastSeen": "2023-06-29T16:04:04.854224-04:00" }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:52.667303+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:50.560804+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/emicklei/go-restful": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:53.698206+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/go-kit/kit/otelkit": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:52.997073+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:49.910545+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:52.172876+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:51.363834+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:53.323307+01:00" + }, + "https://go.opentelemetry.io/contrib/instrumentation/net/http": { + "StatusCode": 200, + "LastSeen": "2023-12-01T16:02:51.080037+01:00" + }, "https://godoc.org/google.golang.org/genproto/googleapis/rpc/status#Status": { "StatusCode": 200, "LastSeen": "2023-06-29T16:09:01.724558-04:00" @@ -5167,6 +5215,10 @@ "StatusCode": 206, "LastSeen": "2023-06-29T18:37:54.454671-04:00" }, + "https://prometheus.io/docs/alerting/latest/alertmanager/": { + "StatusCode": 206, + "LastSeen": "2023-12-01T16:02:43.039481+01:00" + }, "https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels": { "StatusCode": 206, "LastSeen": "2023-06-30T09:18:45.333174-04:00" From 5df8d080fe6997d1ee514b9f50f6880155276e5b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Joaqu=C3=ADn=20Atria?= Date: Tue, 5 Dec 2023 11:04:12 +0000 Subject: [PATCH 03/19] Add recent Perl distributions to registry (#3645) Co-authored-by: svrnm --- data/registry/exporter-perl-otlp.yml | 13 +++++++++++++ .../instrumentation-perl-mojolicious.yml | 13 +++++++++++++ data/registry/instrumentation-perl-plack.yml | 13 +++++++++++++ .../{otel-perl.yml => otel-perl-api.yml} | 2 +- data/registry/otel-perl-sdk.yml | 13 +++++++++++++ static/refcache.json | 16 ++++++++++++++++ 6 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 data/registry/exporter-perl-otlp.yml create mode 100644 data/registry/instrumentation-perl-mojolicious.yml create mode 100644 data/registry/instrumentation-perl-plack.yml rename data/registry/{otel-perl.yml => otel-perl-api.yml} (91%) create mode 100644 data/registry/otel-perl-sdk.yml diff --git a/data/registry/exporter-perl-otlp.yml b/data/registry/exporter-perl-otlp.yml new file mode 100644 index 000000000000..4e789ecb1650 --- /dev/null +++ b/data/registry/exporter-perl-otlp.yml @@ -0,0 +1,13 @@ +# cSpell:ignore jjatria +title: OTLP Exporter for Perl +registryType: instrumentation +isThirdParty: true +language: perl +tags: + - perl + - exporter +repo: https://github.com/jjatria/perl-opentelemetry-exporter-otlp +license: Artistic-1.0-Perl +description: An unofficial implementation of the OTLP Exporter in Perl. +authors: jjatria +otVersion: latest diff --git a/data/registry/instrumentation-perl-mojolicious.yml b/data/registry/instrumentation-perl-mojolicious.yml new file mode 100644 index 000000000000..b3d6081285a4 --- /dev/null +++ b/data/registry/instrumentation-perl-mojolicious.yml @@ -0,0 +1,13 @@ +# cSpell:ignore jjatria Mojolicious +title: Mojolicious Instrumentation +registryType: instrumentation +isThirdParty: true +language: perl +tags: + - perl + - instrumentation +repo: https://github.com/jjatria/mojolicious-plugin-opentelemetry +license: Artistic-1.0-Perl +description: An OpenTelemetry plugin for Perl's Mojolicious. +authors: jjatria +otVersion: latest diff --git a/data/registry/instrumentation-perl-plack.yml b/data/registry/instrumentation-perl-plack.yml new file mode 100644 index 000000000000..7fc5371efd00 --- /dev/null +++ b/data/registry/instrumentation-perl-plack.yml @@ -0,0 +1,13 @@ +# cSpell:ignore abh +title: Plack Instrumentation +registryType: instrumentation +isThirdParty: true +language: perl +tags: + - perl + - instrumentation +repo: https://github.com/abh/Plack-Middleware-OpenTelemetry +license: MIT +description: An OpenTelemetry middleware for Perl's Plack. +authors: abh +otVersion: latest diff --git a/data/registry/otel-perl.yml b/data/registry/otel-perl-api.yml similarity index 91% rename from data/registry/otel-perl.yml rename to data/registry/otel-perl-api.yml index 4c98f729b165..669e30613d6c 100644 --- a/data/registry/otel-perl.yml +++ b/data/registry/otel-perl-api.yml @@ -7,7 +7,7 @@ tags: - perl - instrumentation repo: https://github.com/jjatria/perl-opentelemetry -license: Apache-2.0 +license: Artistic-1.0-Perl description: An unofficial implementation of OpenTelemetry in Perl. authors: jjatria otVersion: latest diff --git a/data/registry/otel-perl-sdk.yml b/data/registry/otel-perl-sdk.yml new file mode 100644 index 000000000000..0595a890673b --- /dev/null +++ b/data/registry/otel-perl-sdk.yml @@ -0,0 +1,13 @@ +# cSpell:ignore jjatria +title: OpenTelemetry SDK for Perl +registryType: instrumentation +isThirdParty: true +language: perl +tags: + - perl + - instrumentation +repo: https://github.com/jjatria/perl-opentelemetry-sdk +license: Artistic-1.0-Perl +description: An unofficial implementation of the OpenTelemetry SDK in Perl. +authors: jjatria +otVersion: latest diff --git a/static/refcache.json b/static/refcache.json index 5fe8e4f0e55a..b2119b96006f 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -2035,6 +2035,10 @@ "StatusCode": 200, "LastSeen": "2023-06-30T09:36:03.927115-04:00" }, + "https://github.com/abh/Plack-Middleware-OpenTelemetry": { + "StatusCode": 200, + "LastSeen": "2023-12-05T11:57:23.574007+01:00" + }, "https://github.com/adnanrahic": { "StatusCode": 200, "LastSeen": "2023-06-30T11:47:55.037621-04:00" @@ -2371,10 +2375,22 @@ "StatusCode": 200, "LastSeen": "2023-06-30T08:33:32.788394-04:00" }, + "https://github.com/jjatria/mojolicious-plugin-opentelemetry": { + "StatusCode": 200, + "LastSeen": "2023-12-05T11:57:22.182586+01:00" + }, "https://github.com/jjatria/perl-opentelemetry": { "StatusCode": 200, "LastSeen": "2023-06-30T08:35:56.066523-04:00" }, + "https://github.com/jjatria/perl-opentelemetry-exporter-otlp": { + "StatusCode": 200, + "LastSeen": "2023-12-05T11:57:20.083522+01:00" + }, + "https://github.com/jjatria/perl-opentelemetry-sdk": { + "StatusCode": 200, + "LastSeen": "2023-12-05T11:57:24.494338+01:00" + }, "https://github.com/jmacd": { "StatusCode": 200, "LastSeen": "2023-11-14T11:45:03.706414+01:00" From 01bc5373eb7d8f3063d841701df0eb741f52f256 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 6 Dec 2023 05:12:53 -0500 Subject: [PATCH 04/19] Drop obsolete hugo config param (#3653) --- hugo.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/hugo.yaml b/hugo.yaml index 9ce69128e1ad..85555deeff26 100644 --- a/hugo.yaml +++ b/hugo.yaml @@ -57,7 +57,6 @@ params: collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools. - font_awesome_version: 5.8.1 github_repo: https://github.com/open-telemetry/opentelemetry.io github_branch: main gcs_engine_id: bde3d634eca9cd335 From 16ecfe7b5055503ab0a320a400dbc381652efa25 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Wed, 6 Dec 2023 17:05:14 +0100 Subject: [PATCH 05/19] Rename .vscode/cspell.json to .cspell.yml (#3644) Co-authored-by: Patrice Chalin --- .cspell.yml | 152 +++++++++++++++++++++++ .github/workflows/check-spelling.yml | 2 +- .gitignore | 1 - .vscode/cspell.json | 152 ----------------------- package.json | 2 +- scripts/normalize-cspell-front-matter.pl | 45 ++++--- 6 files changed, 185 insertions(+), 169 deletions(-) create mode 100644 .cspell.yml delete mode 100644 .vscode/cspell.json diff --git a/.cspell.yml b/.cspell.yml new file mode 100644 index 000000000000..ba0ccb19a97b --- /dev/null +++ b/.cspell.yml @@ -0,0 +1,152 @@ +# cSpell:ignore textlintrc +# For settings, see +# https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/ +version: '0.2' +caseSensitive: true +ignorePaths: + - '*.svg' +# words here are only listed for their spelling, if there is a certain way +# to write a word (e.g. OpenTelemetry vs Opentelemetry or cloud native vs +# cloud-native), edit the text-lint rules in .textlintrc.yml +words: + - accountingservice + - adservice + - alibaba + - Alloc + - Alolita + - APAC + - appdynamics + - appender + - appenders + - aspecto + - autoload + - autoloaded + - autoloader + - autoloading + - backoff + - bytecode + - caml + - cartservice + - cassandra + - checkoutservice + - cncf + - currencyservice + - daemonset + - datadog + - declarators + - discoverability + - dotnet + - Dyla + - dynatrace + - emailservice + - EMEA + - erlang + - errorf + - featureflagservice + - frauddetectionservice + - frontendproxy + - github + - gitpod + - grafana + - gzipped + - Hausenblas + - hugo + - initializers + - instana + - istio + - jaeger + - jaegertracing + - javaagent + - javadoc + - jboss + - jdbc + - julia + - Juraci + - knative + - kotlin + - Kröhling + - kubecon + - kubernetes + - laravel + - lifecycles + - lightstep + - linux + - Loffay + - Mancuso + - microservices + - mongodb + - mysql + - ndjson + - netlify + - Neumann + - nginx + - ocaml + - opamp + - opencensus + - opensearch + - opentelemetry + - opentracing + - openzipkin + - otel + - otel-comms + - otel-endusers + - otelcol + - otep + - otlp + - overridable + - Paixão + - parentbased + - Pavol + - paymentservice + - pluggable + - postgresql + - Pranay + - Prateek + - Println + - productcatalogservice + - prometheus + - proto + - protobuf + - quantile + - quantiles + - quarkus + - quoteservice + - recommendationservice + - redis + - relref + - Rexed + - roadmap + - runtimes + - Rynn + - semconv + - servlet + - Severin + - Sharma + - shippingservice + - shortcode + - snmp + - Socha + - sqlite + - Stalnaker + - stdoutmetric + - Strimzi + - subdir + - symfony + - tabpane + - textlint + - thanos + - tocstop + - tracecontext + - traceidratio + - traceloop + - traceparent + - traefik + - Trask + - uids + - unshallow + - upstreamed + - Villela + - wordpress + - WSGI + - zend + - zipkin diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml index 6f00491f9c76..8cae1dc4b817 100644 --- a/.github/workflows/check-spelling.yml +++ b/.github/workflows/check-spelling.yml @@ -16,7 +16,7 @@ jobs: content/**/*.md layouts/**/*.md data/**/* - config: .vscode/cspell.json + config: .cspell.yml dict-check: name: CSPELL:IGNORE check diff --git a/.gitignore b/.gitignore index a98b06301cbd..5059dd00fe84 100644 --- a/.gitignore +++ b/.gitignore @@ -23,7 +23,6 @@ assets/jsconfig.json # VS Code /.vscode/** -!/.vscode/cspell.json # Webstorm /.idea/** diff --git a/.vscode/cspell.json b/.vscode/cspell.json deleted file mode 100644 index f096bed562c2..000000000000 --- a/.vscode/cspell.json +++ /dev/null @@ -1,152 +0,0 @@ -// For settings, see https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/ -{ - "version": "0.2", - "caseSensitive": true, - "ignorePaths": ["*.svg"], - // words here are only listed for their spelling, if there is a certain way - // to write a word (e.g. OpenTelemetry vs Opentelemetry or cloud native vs - // cloud-native), edit the text-lint rules in .textlintrc.json - "words": [ - "accountingservice", - "adservice", - "alibaba", - "Alloc", - "Alolita", - "APAC", - "appdynamics", - "appender", - "appenders", - "aspecto", - "autoload", - "autoloaded", - "autoloader", - "autoloading", - "backoff", - "bytecode", - "caml", - "cartservice", - "cassandra", - "checkoutservice", - "cncf", - "currencyservice", - "daemonset", - "datadog", - "declarators", - "discoverability", - "dotnet", - "Dyla", - "dynatrace", - "emailservice", - "EMEA", - "erlang", - "errorf", - "featureflagservice", - "frauddetectionservice", - "frontendproxy", - "github", - "gitpod", - "grafana", - "gzipped", - "Hausenblas", - "hugo", - "initializers", - "instana", - "istio", - "jaeger", - "jaegertracing", - "javaagent", - "javadoc", - "jboss", - "jdbc", - "julia", - "Juraci", - "knative", - "kotlin", - "Kröhling", - "kubecon", - "kubernetes", - "laravel", - "lifecycles", - "lightstep", - "linux", - "Loffay", - "Mancuso", - "microservices", - "mongodb", - "mysql", - "ndjson", - "netlify", - "Neumann", - "nginx", - "ocaml", - "opamp", - "opencensus", - "opensearch", - "opentelemetry", - "opentracing", - "openzipkin", - "otel", - "otel-comms", - "otel-endusers", - "otelcol", - "otep", - "otlp", - "overridable", - "Paixão", - "parentbased", - "Pavol", - "paymentservice", - "pluggable", - "postgresql", - "Pranay", - "Prateek", - "Println", - "productcatalogservice", - "prometheus", - "proto", - "protobuf", - "quantile", - "quantiles", - "quarkus", - "quoteservice", - "recommendationservice", - "redis", - "relref", - "Rexed", - "roadmap", - "runtimes", - "Rynn", - "semconv", - "servlet", - "Severin", - "Sharma", - "shippingservice", - "shortcode", - "snmp", - "Socha", - "sqlite", - "Stalnaker", - "stdoutmetric", - "Strimzi", - "subdir", - "symfony", - "tabpane", - "textlint", - "thanos", - "tocstop", - "tracecontext", - "traceidratio", - "traceloop", - "traceparent", - "traefik", - "Trask", - "uids", - "unshallow", - "upstreamed", - "Villela", - "wordpress", - "WSGI", - "zend", - "zipkin" - ] -} diff --git a/package.json b/package.json index 3f55465f3415..b2d9bb8f1a8b 100644 --- a/package.json +++ b/package.json @@ -39,7 +39,7 @@ "check:links:internal": "npm run _check:links:internal", "check:links": "npm run _check:links", "check:markdown": "npx gulp lint-md", - "check:spelling": "npx cspell --no-progress -c .vscode/cspell.json content data 'layouts/**/*.md'", + "check:spelling": "npx cspell --no-progress -c .cspell.yml content data 'layouts/**/*.md'", "check:text": "npm run _check:text -- ", "check": "npm run seq -- $(npm run -s _list:check:*)", "clean": "make clean", diff --git a/scripts/normalize-cspell-front-matter.pl b/scripts/normalize-cspell-front-matter.pl index 16f5a8168c00..f6c78f0c3c12 100755 --- a/scripts/normalize-cspell-front-matter.pl +++ b/scripts/normalize-cspell-front-matter.pl @@ -2,14 +2,13 @@ use strict; use warnings; -use JSON::PP; use FileHandle; my @words; my $lineLenLimit = 79; my $last_file = ''; my $last_line = ''; -my %dictionary = getSiteWideDictWords('.vscode/cspell.json', '.textlintrc.yml'); +my %dictionary = getSiteWideDictWords('.cspell.yml', '.textlintrc.yml'); while (<>) { if (/^\s*(spelling: |-\s*)?cSpell:ignore:?\s*(.*)$/ @@ -41,26 +40,44 @@ sub getSiteWideDictWords { my $dictionary_file = shift; my $textlintrc_file = shift; - # Read the cspell.json file - my $fh = FileHandle->new($dictionary_file, "r") or die "Could not open file '$dictionary_file': $!"; - my $json_text = join "", $fh->getlines(); + my %dictionary = readYmlListOfWords('words', $dictionary_file); + my %textlintDictionary = readYmlListOfWords('terms', $textlintrc_file); + # Merge dictionaries + @dictionary{keys %textlintDictionary} = values %textlintDictionary; - # Remove JSON comments - $json_text =~ s/^\s*\/\/.*$//mg; + return %dictionary; +} - my $json = JSON::PP->new; - my $data = $json->decode($json_text); - my %dictionary = map { $_ => 1 } @{ $data->{words} }; +sub readYmlListOfWords { + my $wordsFieldName = shift; + my $file_path = shift; + my $fh = FileHandle->new($file_path, "r") or die "Could not open file '$file_path': $!"; + my @lines = $fh->getlines(); + $fh->close(); - my %textlintDictionary = processTextlintRcYml($textlintrc_file); + my %dictionary; + my $indentation = ''; + my $in_terms = 0; + foreach my $line (@lines) { + chomp $line; + if ($line =~ /^(\s*)$wordsFieldName:/) { + $indentation = $1 || ''; + $in_terms = 1; + # print STDOUT "Found terms!"; + } elsif ($line =~ /^$indentation - (\w[^\s]*)$/ && $in_terms) { + my $term = $1; + $dictionary{$term} = 1 if $term; + } elsif ($line !~ /^ / && $in_terms) { + $in_terms = 0; + } + } - # Merge dictionaries - @dictionary{keys %textlintDictionary} = values %textlintDictionary; + die "ERROR: no words read from '$file_path'!" unless %dictionary; # sanity check return %dictionary; } -sub processTextlintRcYml { +sub processTextlintRc { my $file_path = shift; my $fh = FileHandle->new($file_path, "r") or die "Could not open file '$file_path': $!"; my @lines = $fh->getlines(); From 181474bc56856d77a5f23187d6932c7a380140aa Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Wed, 6 Dec 2023 18:08:36 +0100 Subject: [PATCH 06/19] [blog] OTel in Focus Break (#3654) --- content/en/blog/2023/otel-in-focus-break.md | 22 +++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 content/en/blog/2023/otel-in-focus-break.md diff --git a/content/en/blog/2023/otel-in-focus-break.md b/content/en/blog/2023/otel-in-focus-break.md new file mode 100644 index 000000000000..f6015170f1b6 --- /dev/null +++ b/content/en/blog/2023/otel-in-focus-break.md @@ -0,0 +1,22 @@ +--- +title: 'OpenTelemetry in Focus: Wrapping Up a Successful 2023' +linkTitle: OTel in Focus Wrap-Up +date: 2023-12-06 +author: '[Severin Neumann](https://github.com/svrnm) (Cisco)' +--- + +As we approach the end of an eventful year, we're announcing that "OpenTelemetry +in Focus", our platform for sharing updates about the OpenTelemetry project, is +taking an end-of-year break after ten successful editions in 2023. + +Over the past year, OpenTelemetry in Focus has been a key resource for news and +insights about the OpenTelemetry project. +[Austin Parker](https://github.com/austinlparker) aimed to give a clear picture +of OTel's progress, the issues that got solved, and what is planned for the +future. + +In those ten editions, each issue has highlighted the ongoing work, creativity, +and dedication that drive the OpenTelemetry project. + +While OpenTelemetry in Focus is on a break, we will be working on a new and +improved format for it. Stay tuned! From 8564d00afdd30958fb5aaca7a7d94ace3a6c3b84 Mon Sep 17 00:00:00 2001 From: ekquasar <123695626+ekquasar@users.noreply.github.com> Date: Wed, 6 Dec 2023 13:25:03 -0500 Subject: [PATCH 07/19] Fix for OTEL-3607 (#3609) --- content/en/docs/instrumentation/python/getting-started.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/instrumentation/python/getting-started.md b/content/en/docs/instrumentation/python/getting-started.md index aa2e9ca1a975..6f0a0c98f6ba 100644 --- a/content/en/docs/instrumentation/python/getting-started.md +++ b/content/en/docs/instrumentation/python/getting-started.md @@ -36,8 +36,8 @@ To begin, set up an environment in a new directory: ```shell mkdir otel-getting-started cd otel-getting-started -python3 -m venv . -source ./bin/activate +python3 -m venv venv +source ./venv/bin/activate ``` Now install Flask: @@ -64,7 +64,7 @@ def roll_dice(): player = request.args.get('player', default = None, type = str) result = str(roll()) if player: - logger.warn("{} is rolling the dice: {}", player, result) + logger.warn("%s is rolling the dice: %s", player, result) else: logger.warn("Anonymous player is rolling the dice: %s", result) return result From d8b6a976e8694e4ca036e00345fc6275ecb64203 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Thu, 7 Dec 2023 03:36:57 +0100 Subject: [PATCH 08/19] Pin werkzeug version to fix python getting started issue (#3655) --- content/en/docs/instrumentation/python/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/instrumentation/python/getting-started.md b/content/en/docs/instrumentation/python/getting-started.md index 6f0a0c98f6ba..fc481392051d 100644 --- a/content/en/docs/instrumentation/python/getting-started.md +++ b/content/en/docs/instrumentation/python/getting-started.md @@ -2,7 +2,7 @@ title: Getting Started description: Get telemetry for your app in less than 5 minutes! # prettier-ignore -cSpell:ignore: debugexporter diceroller distro loglevel maxlen randint rolldice rollspan venv +cSpell:ignore: debugexporter diceroller distro loglevel maxlen randint rolldice rollspan venv werkzeug weight: 10 --- @@ -43,7 +43,7 @@ source ./venv/bin/activate Now install Flask: ```shell -pip install 'flask<3' +pip install 'flask<3' 'werkzeug<3' ``` ### Create and launch an HTTP Server From 839cb224ffe91805dad4c5b819cc915c42eb679c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sim=C3=A3o=20Ribeiro?= Date: Thu, 7 Dec 2023 12:09:52 +0000 Subject: [PATCH 09/19] Add KafkaFlow instrumentation to registry (#3625) --- .../instrumentation-dotnet-kafkaflow.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 data/registry/instrumentation-dotnet-kafkaflow.yml diff --git a/data/registry/instrumentation-dotnet-kafkaflow.yml b/data/registry/instrumentation-dotnet-kafkaflow.yml new file mode 100644 index 000000000000..333024e4dbc2 --- /dev/null +++ b/data/registry/instrumentation-dotnet-kafkaflow.yml @@ -0,0 +1,17 @@ +# cSpell:ignore kafkaflow farfetch +title: KafkaFlow Instrumentation for OpenTelemetry +registryType: instrumentation +isThirdParty: true +language: dotnet +tags: + - kafka + - kafkaflow + - instrumentation + - dotnet +repo: https://github.com/Farfetch/kafkaflow/tree/master/src/KafkaFlow.OpenTelemetry +license: MIT +description: + This is an Instrumentation Library, which instruments KafkaFlow and collects + traces and baggage signals about Kafka messaging. +authors: Farfetch +otVersion: latest From 4750f0fe73b25a7cce9332bb448e058e3a775348 Mon Sep 17 00:00:00 2001 From: Bright Zheng Date: Fri, 8 Dec 2023 00:18:02 +0800 Subject: [PATCH 10/19] Update Collector configuration telemetry section (#3483) --- content/en/docs/collector/configuration.md | 113 ++++++++++++++++----- 1 file changed, 87 insertions(+), 26 deletions(-) diff --git a/content/en/docs/collector/configuration.md b/content/en/docs/collector/configuration.md index fa70a5c3b258..8a8ac5c2f73d 100644 --- a/content/en/docs/collector/configuration.md +++ b/content/en/docs/collector/configuration.md @@ -496,10 +496,10 @@ extensions: ## Service section {#service} -The service section is used to configure what components are enabled in the +The `service` section is used to configure what components are enabled in the Collector based on the configuration found in the receivers, processors, exporters, and extensions sections. If a component is configured, but not -defined within the service section, then it's not enabled. +defined within the `service` section, then it's not enabled. The service section consists of three subsections: @@ -509,8 +509,8 @@ The service section consists of three subsections: ### Extensions {#service-extensions} -The `extensions` subsection consists of a list of all extensions to enable. For -example: +The `extensions` subsection consists of a list of desired extensions to be +enabled. For example: ```yaml service: @@ -519,8 +519,8 @@ service: ### Pipelines -Pipelines are defined in the `pipelines` subsection and can be of the following -types: +The `pipelines` subsection is where the pipelines are configured, which can be +of the following types: - `traces` collect and processes trace data. - `metrics` collect and processes metric data. @@ -552,30 +552,60 @@ service: ### Telemetry -You can configure telemetry for the Collector itself in the `telemetry` -subsection inside the `service` section. Collector telemetry can be useful when -troubleshooting Collector issues. - -The `logs` subsection lets you configure logs generated by the Collector. By -default, the Collector writes its logs to stderr with a log level of `INFO`. You -can also add static key-value pairs to all logs using the `initial_fields` -section. See the full list of `logs` options -[here.](https://github.com/open-telemetry/opentelemetry-collector/blob/7666eb04c30e5cfd750db9969fe507562598f0ae/config/service.go#L41-L97) - -The `metrics` subsection lets you configure metrics generated by the Collector. -By default, the Collector generates basic metrics about itself and expose them -for scraping at . For the full list of options -for the `metrics` subsection, see the -[`ServiceTelemetryMetrics struct`](https://github.com/open-telemetry/opentelemetry-collector/blob/7666eb04c30e5cfd750db9969fe507562598f0ae/config/service.go#L99-L111) -comments. - -The following example shows Collector telemetry configuration: +The `telemetry` is where the telemetry for the Collector itself can be +configured. Collector's own telemetry can be useful when troubleshooting +Collector issues. It consists of two subsections: `logs` and `metrics`. + +The `logs` subsection lets you configure how the logs can be generated by the +Collector. By default, the Collector writes its logs to `stderr` with a log +level of `INFO`. You can also add static key-value pairs to all log entries with +the `initial_fields` to enrich the logging context. As per the `LogsConfig` +defined in v{{% +param vers %}} [here](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% +param vers %}}/service/telemetry/config.go), the `logs` configuration options are: + +- `level`: sets the minimum enabled logging level, default `INFO`. +- `development`: puts the logger in development mode, default `false`. +- `encoding`: sets the logger's encoding, default `console`. Example values are + `json`, `console`. +- `disable_caller`: stops annotating logs with the calling function's file name + and line number. By default `false`, all logs are annotated. +- `disable_stacktrace`: disables automatic stacktrace capturing, default + `false`. By default, stacktraces are captured for `WARN` level and above logs + in development and `ERROR` level and above in production. +- `sampling`: sets a sampling policy. +- `output_paths`: a list of URLs or file paths to write logging output to, + default `["stderr"]`. +- `error_output_paths`: a list of URLs or file paths to write logger errors to, + default `["stderr"]`. +- `initial_fields`: a collection of fields to add to the root logger. By + default, there is no initial field. + +The `metrics` subsection lets you configure how the metrics can be generated and +exposed by the Collector. By default, the Collector generates basic metrics +about itself and expose them for scraping at . +You can expose the endpoint to a specific or even all network interfaces when +needed. As per the `MetricsConfig` defined in v{{% +param vers %}} [here](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% +param vers %}}/service/telemetry/config.go), the `metrics` configuration options +are: + +- `level`: the level of telemetry metrics, default `basic`. The possible values + are: + - "none" indicates that no telemetry data should be collected. + - "basic" is the recommended and covers the basics of the service telemetry. + - "normal" adds some other indicators on top of basic. + - "detailed" adds dimensions and views to the previous levels. +- `address`: the `[address]:port` formatted URL that metrics exposition should + be bound to. Default `127.0.0.1:8888`. + +The following example shows the Collector telemetry configuration: ```yaml service: telemetry: logs: - level: debug + level: DEBUG initial_fields: service: my-instance metrics: @@ -583,7 +613,38 @@ service: address: 0.0.0.0:8888 ``` -## Additional information +Note that it's possible to scrape the metrics by using a +[Prometheus receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver) +within the Collector configuration so that we can consume the Collector's +metrics at the backend. For example: + +```yaml +receivers: + prometheus: + trim_metric_suffixes: true + use_start_time_metric: true + start_time_metric_regex: .* + config: + scrape_configs: + - job_name: 'otel-collector' + scrape_interval: 5s + static_configs: + - targets: ['127.0.0.1:8888'] + +exporters: + otlp: + endpoint: my.company.com:4317 + tls: + insecure: true + +service: + pipelines: + metrics: + receivers: [prometheus] + exporters: [otlp] +``` + +## Other Information ### Environment variables From 210e9c6c0d0279a7292e31bfe6fb54032ae44b87 Mon Sep 17 00:00:00 2001 From: Jean Bisutti Date: Fri, 8 Dec 2023 12:38:15 +0100 Subject: [PATCH 11/19] Add blog spot for Spring native images (#3612) --- content/en/blog/2023/spring-native/index.md | 80 +++++++++++++++++++++ static/refcache.json | 24 +++++++ 2 files changed, 104 insertions(+) create mode 100644 content/en/blog/2023/spring-native/index.md diff --git a/content/en/blog/2023/spring-native/index.md b/content/en/blog/2023/spring-native/index.md new file mode 100644 index 000000000000..847f330afbf4 --- /dev/null +++ b/content/en/blog/2023/spring-native/index.md @@ -0,0 +1,80 @@ +--- +title: Observe your Spring Native Image application with OpenTelemetry +linkTitle: Observe Spring Native +date: 2023-12-08 +author: >- + [Jean Bisutti](https://github.com/jeanbisutti) (Microsoft) +cSpell:ignore: bisutti datasource logback +--- + +The [OpenTelemetry Java agent](/docs/instrumentation/java/automatic) is a +convenient and well-established way to instrument Java applications. However, as +of today +[it is not possible to use it with GraalVM Native Images](https://github.com/oracle/graal/issues/1065). + +To provide you with an easy and seamless way for Spring Boot Native Image +application nevertheless, the OpenTelemetry Java contributors have improved the +existing OpenTelemetry Spring Boot Starter to work well with Spring Boot Native +Image applications. Read on to learn more! + +## A history of the last months + +The OpenTelemetry Spring Boot Starter allows to add OpenTelemetry to your +application without byte code instrumentation. The OpenTelemetry Java +contributors have used this to instrument Spring Boot Native Images. By adding +the starter dependency to your project, you will benefit from an OTLP exports of +logs (added the last months), spans and metrics, with an auto-instrumentation +for Spring HTTP frameworks (updated the last months to make it work with Spring +Boot 3) out of the box: + +```xml + + + io.opentelemetry.instrumentation + opentelemetry-spring-boot-starter + 1.32.0-alpha + + +``` + +To get even more visibility, the Starter can be combined with +[instrumentation libraries](/docs/instrumentation/java/libraries/). For this +purpose, the OpenTelemetry Java contributors have improved the JDBC (database) +libraries and logging instrumentation libraries. For example, for the Logback +logging library, they have added GraalVM configuration to make the library work +in native mode[^1]. + +Furthermore, they have worked to reduce the configuration to set up the logging +and database instrumentation with the Starter. For example, if your application +does not declare a DataSource bean, you can enable the database by simply adding +two properties in the `application.properties` file: + +```properties +spring.datasource.url=jdbc:otel:h2:mem:db +spring.datasource.driver-class-name=io.opentelemetry.instrumentation.jdbc.OpenTelemetryDriver +``` + +Read the [documentation](/docs/instrumentation/java/automatic/spring-boot/) of +the OpenTelemetry Spring Boot Starter to learn more. You can use +[opentelemetry-java-examples/spring-native](https://github.com/open-telemetry/opentelemetry-java-examples/tree/main/spring-native) +to run a Spring Boot Native Image application and look at the generated logs as +well as HTTP and database telemetry data. + +Finally, the OpenTelemetry Java contributors have added GraalVM Native automatic +tests to the OpenTelemetry Java project to detect regressions related to the +native mode execution. + +## What’s next? + +The OpenTelemetry Java contributors expect to be able to enable automatic +logging and database instrumentation configuration. + +If you try out the OpenTelemetry Spring Boot Starter, share your thoughts and +experiences via +[GitHub discussions](https://github.com/open-telemetry/opentelemetry-java/discussions) +or the [#otel-java](https://cloud-native.slack.com/archives/C014L2KCTE3) +[CNCF Slack](https://slack.cncf.io) channel. + +[^1]: + Spring Boot Native Image applications + [do not support Log4j2 logging library](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-with-GraalVM). diff --git a/static/refcache.json b/static/refcache.json index b2119b96006f..80a2b3fd695d 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -255,6 +255,10 @@ "StatusCode": 206, "LastSeen": "2023-06-30T09:37:46.480932-04:00" }, + "https://cloud-native.slack.com/archives/C014L2KCTE3": { + "StatusCode": 200, + "LastSeen": "2023-12-08T11:19:16.128163+01:00" + }, "https://cloud-native.slack.com/archives/C01N5UCHTEH": { "StatusCode": 200, "LastSeen": "2023-06-30T09:38:12.370641-04:00" @@ -2371,6 +2375,10 @@ "StatusCode": 200, "LastSeen": "2023-10-23T22:46:44.940049+02:00" }, + "https://github.com/jeanbisutti": { + "StatusCode": 200, + "LastSeen": "2023-12-08T11:19:13.539577+01:00" + }, "https://github.com/jenniferplusplus/opentelemetry-instrumentation-bullmq": { "StatusCode": 200, "LastSeen": "2023-06-30T08:33:32.788394-04:00" @@ -3203,6 +3211,10 @@ "StatusCode": 200, "LastSeen": "2023-11-01T21:52:02.990981-04:00" }, + "https://github.com/open-telemetry/opentelemetry-java/discussions": { + "StatusCode": 200, + "LastSeen": "2023-12-08T11:19:15.572149+01:00" + }, "https://github.com/open-telemetry/opentelemetry-java/releases": { "StatusCode": 200, "LastSeen": "2023-06-30T08:47:15.179862-04:00" @@ -3731,6 +3743,10 @@ "StatusCode": 200, "LastSeen": "2023-06-30T08:42:08.536962-04:00" }, + "https://github.com/oracle/graal/issues/1065": { + "StatusCode": 200, + "LastSeen": "2023-12-08T11:19:14.694346+01:00" + }, "https://github.com/orgs/open-telemetry/projects/41/views/1": { "StatusCode": 200, "LastSeen": "2023-06-30T09:42:42.642961-04:00" @@ -3839,6 +3855,10 @@ "StatusCode": 200, "LastSeen": "2023-06-30T09:27:42.016103-04:00" }, + "https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-with-GraalVM": { + "StatusCode": 200, + "LastSeen": "2023-12-08T11:19:16.63837+01:00" + }, "https://github.com/statsd/statsd": { "StatusCode": 200, "LastSeen": "2023-06-30T08:39:57.115625-04:00" @@ -4907,6 +4927,10 @@ "StatusCode": 206, "LastSeen": "2023-09-08T10:56:59.732967-04:00" }, + "https://opentelemetry.io/docs/instrumentation/java/automatic/spring-boot/": { + "StatusCode": 206, + "LastSeen": "2023-12-08T11:19:15.011115+01:00" + }, "https://opentracing.io": { "StatusCode": 206, "LastSeen": "2023-06-29T18:41:30.83242-04:00" From 0000a92d8256b10e9b1ce8fc153aef8a2bf9a469 Mon Sep 17 00:00:00 2001 From: Andrew Hillier <73840999+andrew-hillier@users.noreply.github.com> Date: Fri, 8 Dec 2023 20:40:46 +0000 Subject: [PATCH 12/19] improve dotnet getting started instructions (#3661) --- .../instrumentation/net/getting-started.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/content/en/docs/instrumentation/net/getting-started.md b/content/en/docs/instrumentation/net/getting-started.md index 82a86a78f632..37eadeabc2ca 100644 --- a/content/en/docs/instrumentation/net/getting-started.md +++ b/content/en/docs/instrumentation/net/getting-started.md @@ -46,6 +46,8 @@ code: ```csharp using System.Globalization; +using Microsoft.AspNetCore.Mvc; + var builder = WebApplication.CreateBuilder(args); var app = builder.Build(); @@ -65,6 +67,11 @@ string HandleRollDice([FromServices]ILogger logger, string? player) return result.ToString(CultureInfo.InvariantCulture); } +int RollDice() +{ + return Random.Shared.Next(1, 7); +} + app.MapGet("/rolldice/{player?}", HandleRollDice); app.Run(); @@ -114,7 +121,21 @@ that will generate the telemetry, and set them up. 2. Setup the OpenTelemetry code + In Program.cs, replace the following lines: + + ```csharp + var builder = WebApplication.CreateBuilder(args); + var app = builder.Build(); + ``` + + With: + ```csharp + using OpenTelemetry.Logs; + using OpenTelemetry.Metrics; + using OpenTelemetry.Resources; + using OpenTelemetry.Trace; + var builder = WebApplication.CreateBuilder(args); const string serviceName = "roll-dice"; From 299ad7bb24488e39eb17d43393dd05f513321253 Mon Sep 17 00:00:00 2001 From: OpenTelemetry Bot <107717825+opentelemetrybot@users.noreply.github.com> Date: Fri, 8 Dec 2023 23:02:07 +0100 Subject: [PATCH 13/19] Update opentelemetry-java version to 1.33.0 (#3663) --- content/en/docs/instrumentation/java/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/instrumentation/java/_index.md b/content/en/docs/instrumentation/java/_index.md index ee92b9e2a9f3..a9d657e5ddf1 100644 --- a/content/en/docs/instrumentation/java/_index.md +++ b/content/en/docs/instrumentation/java/_index.md @@ -7,7 +7,7 @@ aliases: [/java, /java/metrics, /java/tracing] cascade: vers: instrumentation: 1.32.0 - otel: 1.32.0 + otel: 1.33.0 semconv: 1.23.1 weight: 18 --- From 95e83ad9bd4fd729678ccc98d7497b452edc04f1 Mon Sep 17 00:00:00 2001 From: Martin Kuba Date: Sun, 10 Dec 2023 10:56:32 -0800 Subject: [PATCH 14/19] Add CVE page (#3659) Co-authored-by: Severin Neumann Co-authored-by: Phillip Carter --- content/en/docs/security/_index.md | 4 ++ content/en/docs/security/cve.md | 74 ++++++++++++++++++++++++++++++ static/refcache.json | 8 ++++ 3 files changed, 86 insertions(+) create mode 100644 content/en/docs/security/_index.md create mode 100644 content/en/docs/security/cve.md diff --git a/content/en/docs/security/_index.md b/content/en/docs/security/_index.md new file mode 100644 index 000000000000..27d2cfac5544 --- /dev/null +++ b/content/en/docs/security/_index.md @@ -0,0 +1,4 @@ +--- +title: Security +weight: 150 +--- diff --git a/content/en/docs/security/cve.md b/content/en/docs/security/cve.md new file mode 100644 index 000000000000..3c6b8fb18730 --- /dev/null +++ b/content/en/docs/security/cve.md @@ -0,0 +1,74 @@ +--- +title: Common Vulnerabilities and Exposures +weight: 102 +--- + +This is a list of reported Common Vulnerabilities and Exposures (CVEs) across +all repositories in the +[OpenTelemetry organization on GitHub](https://github.com/open-telemetry/). The +raw data is stored in the +[sig-security](https://github.com/open-telemetry/sig-security) repository, and +it is refreshed daily. + + + + + + + + + + + + +
CVE IDIssue SummarySeverityRepository
+ + diff --git a/static/refcache.json b/static/refcache.json index 80a2b3fd695d..1fe39ea2a263 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -2551,6 +2551,10 @@ "StatusCode": 200, "LastSeen": "2023-06-30T08:31:22.656334-04:00" }, + "https://github.com/open-telemetry/": { + "StatusCode": 200, + "LastSeen": "2023-12-08T15:19:55.887939-08:00" + }, "https://github.com/open-telemetry/community": { "StatusCode": 200, "LastSeen": "2023-06-30T09:28:03.502113-04:00" @@ -3723,6 +3727,10 @@ "StatusCode": 200, "LastSeen": "2023-11-03T20:22:42.689401141Z" }, + "https://github.com/open-telemetry/sig-security": { + "StatusCode": 200, + "LastSeen": "2023-12-07T16:14:09.891942-08:00" + }, "https://github.com/opentracing": { "StatusCode": 200, "LastSeen": "2023-06-30T08:40:39.909083-04:00" From 79e4e031d53d749efc0b95e322dfdca2266fa918 Mon Sep 17 00:00:00 2001 From: Steve Flanders Date: Sun, 10 Dec 2023 22:15:52 -0500 Subject: [PATCH 15/19] Add distribution to glossary.md (#3667) Co-authored-by: Phillip Carter --- content/en/docs/concepts/glossary.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/en/docs/concepts/glossary.md b/content/en/docs/concepts/glossary.md index 8d00ac455cfe..43ecaf5f1bd2 100644 --- a/content/en/docs/concepts/glossary.md +++ b/content/en/docs/concepts/glossary.md @@ -104,6 +104,11 @@ transverses process, network and security boundaries. More on Distributed Tracing [here][distributed tracing]. +### **Distribution** + +A distribution is a wrapper around an upstream OpenTelemetry repository with +some customizations. See [more][distribution]. + ### **Event** Something that happened where representation depends on the @@ -338,6 +343,7 @@ on web pages when requested. See [more][zpages]. [context propagation]: /docs/specs/otel/overview#context-propagation [dag]: https://en.wikipedia.org/wiki/Directed_acyclic_graph [distributed tracing]: /docs/concepts/signals/traces/ +[distribution]: /docs/concepts/distributions/ [field]: /docs/specs/otel/logs/data-model#field-kinds [http]: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol [json]: https://en.wikipedia.org/wiki/JSON From 74c06f6402e4d96d4e8008a4b2e6b6c5fe37f998 Mon Sep 17 00:00:00 2001 From: Heitor Tashiro Sergent Date: Mon, 11 Dec 2023 05:32:06 -0500 Subject: [PATCH 16/19] Fix missing parenthesis in docker-deployment.md (#3664) --- content/en/docs/demo/docker-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/demo/docker-deployment.md b/content/en/docs/demo/docker-deployment.md index 45ca70178ede..8fa1e3032eef 100644 --- a/content/en/docs/demo/docker-deployment.md +++ b/content/en/docs/demo/docker-deployment.md @@ -76,7 +76,7 @@ Once the images are built and containers are started you can access: Likely you want to use the web store as a demo application for an observability backend you already have (e.g., an existing instance of Jaeger, Zipkin, or one -of the [vendor of your choice](/ecosystem/vendors/). +of the [vendors of your choice](/ecosystem/vendors/)). OpenTelemetry Collector can be used to export telemetry data to multiple backends. By default, the collector in the demo application will merge the From b15af3ecdba9df34f247ccbfe38412de4a069fdb Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Mon, 11 Dec 2023 05:39:05 -0500 Subject: [PATCH 17/19] Update docsy to v0.8.0-6-g6a71096 (#3666) --- themes/docsy | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/docsy b/themes/docsy index 6bb4f99d1eab..6a71096ef3fa 160000 --- a/themes/docsy +++ b/themes/docsy @@ -1 +1 @@ -Subproject commit 6bb4f99d1eab4976fb80d1488c81ba12b1715c05 +Subproject commit 6a71096ef3fad14504eb2f4f1656ec10b34a62f9 From 276fb12c3d3ac41555113ad7cd99ecfee95acc2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adnan=20Rahi=C4=87?= Date: Mon, 11 Dec 2023 15:32:26 +0100 Subject: [PATCH 18/19] ecosystem(vendors): add tracetest to vendors (#3662) --- data/ecosystem/vendors.yaml | 9 ++++++++- static/refcache.json | 4 ++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/data/ecosystem/vendors.yaml b/data/ecosystem/vendors.yaml index 6260e8e5a8a2..8383faf6e0f1 100644 --- a/data/ecosystem/vendors.yaml +++ b/data/ecosystem/vendors.yaml @@ -1,4 +1,4 @@ -# cSpell:ignore Coralogix Cribl ITRS Kloud Logz Crowdstrike Humio Lumigo observ Teletrace Uptrace Greptime KloudMate qryn ClickHouse +# cSpell:ignore Coralogix Cribl ITRS Kloud Logz Crowdstrike Humio Lumigo observ Teletrace Uptrace Greptime KloudMate qryn ClickHouse Tracetest - name: AppDynamics (Cisco) distribution: true nativeOTLP: true @@ -356,3 +356,10 @@ contact: 'https://github.com/hagen1778' oss: true commercial: true +- name: Tracetest + distribution: false + nativeOTLP: true + url: 'https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector' + contact: 'https://github.com/adnanrahic' + oss: true + commercial: true diff --git a/static/refcache.json b/static/refcache.json index 1fe39ea2a263..7b9d63b7cb63 100644 --- a/static/refcache.json +++ b/static/refcache.json @@ -1519,6 +1519,10 @@ "StatusCode": 206, "LastSeen": "2023-06-30T11:39:40.231517-04:00" }, + "https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector": { + "StatusCode": 206, + "LastSeen": "2023-12-11T14:19:28.382469+01:00" + }, "https://docs.vmware.com/en/vRealize-Log-Insight/8.4/com.vmware.log-insight.agent.admin.doc/GUID-40C13E10-1554-4F1B-B832-69CEBF85E7A0.html": { "StatusCode": 206, "LastSeen": "2023-06-28T13:36:46.411249-04:00" From 579b647e1630cad165e5f131ac9fa5469e4a3155 Mon Sep 17 00:00:00 2001 From: Severin Neumann Date: Mon, 11 Dec 2023 20:24:53 +0100 Subject: [PATCH 19/19] Add approvers & maintainers corner to CONTRIBUTING.md (#3632) Co-authored-by: Fabrizio Ferri-Benedetti Co-authored-by: opentelemetrybot <107717825+opentelemetrybot@users.noreply.github.com> Co-authored-by: Phillip Carter --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6802c7dabc37..94a3bcf27a6e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -266,6 +266,39 @@ the production server. To see deploy logs and more, visit project's [dashboard][] -- Netlify login required. +## Approver and Maintainer practices + +This last section includes guidelines and some common practices used by +approvers and maintainers while doing code reviews: + +- PRs with changes to documentation co-owned by a SIG (collector, demo, + language-specific...) should aim for two approvals: one by a docs approver and + one by a SIG approver: + - Doc approver label such PRs with `sig:` and tag the SIG `-approvers` + group on that PR + - If no SIG approval is given within a certain grace period (two weeks in + general, but may be less in urgent cases), docs maintainer may use their own + judgement to merge that PR +- If the PR branch is `out-of-date with the base branch`, they do not need to be + updated continuously: every update triggers all the PR CI checks to be run! + It's often enough to update them before merging. +- A PR by non-maintainers should **never** update git sub modules. This happens + by accident from time to time. Let the PR author know that they should not + worry about it, we will fix this before merging, but in the future they should + make sure that they work from an up-to-date fork. +- If the contributor is having trouble signing the CLA or used the wrong email + by mistake in one of their commits, ask them to fix the issue or rebase the + pull request. Worst case scenario, close and re-open the PR to trigger a new + CLA check. +- Words unknown to cspell should be added to the cspell ignore list per page by + PR authors. Only approvers and maintainers will add commonly used terms to the + global list. +- When an approver or maintainer won't be available to contribute for an + extended period of time (more than a few days or a week) or won't be available + in that period of time, they should communicate this using the + [#otel-comms](https://cloud-native.slack.com/archives/C02UN96HZH6) channel and + updating the GitHub status. + [.nvmrc]: .nvmrc [clone]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository