No matches found
'; - } + document.addEventListener('DOMContentLoaded', (event) => { + let searchForm = document.getElementById('searchForm'); + searchForm.addEventListener('submit', function (evt) { + evt.preventDefault(); + let val = document.getElementById('input-s').value; + setInput('s', val); + parseUrlParams(); + executeSearch(searchQuery); }); -} -// Populate the search results and render to the page -function populateResults(results) { - results.forEach((result, key) => { - let contents = result.item.description; - let snippet = ''; - let snippetHighlights = []; - - if (fuseOptions.tokenize) { - snippetHighlights.push(searchQuery); - } else { - result.matches.forEach((match) => { - if (match.key === 'tags' || match.key === 'categories') { - snippetHighlights.push(match.value); - } else if (match.key === 'description') { - start = - match.indices[0][0] - summaryInclude > 0 - ? match.indices[0][0] - summaryInclude - : 0; - end = - match.indices[0][1] + summaryInclude < contents.length - ? match.indices[0][1] + summaryInclude - : contents.length; - snippet += contents.substring(start, end); - snippetHighlights.push( - match.value.substring( - match.indices[0][0], - match.indices[0][1] - mvalue.indices[0][0] + 1, - ), - ); - } - }); - } - - if (snippet.length < 1 && contents.length > 0) { - snippet += contents.substring(0, summaryInclude * 2); - } - - // Pull template from hugo template definition - let templateDefinition = document.querySelector( - '#search-result-template', - ).innerHTML; - - // Replace values from template with search results - let output = render(templateDefinition, { - key: key, - title: result.item.title, - link: result.item.permalink, - tags: result.item.tags, - categories: result.item.categories, - description: result.item.description, - repo: result.item.repo, - registryType: result.item.registryType, - language: result.item.language, - snippet: snippet, - otVersion: result.item.otVersion, + let searchInput = document.getElementById('input-s'); + searchInput.addEventListener('keyup', function (evt) { + autoSuggest(evt.target.value); }); - document.querySelector('#search-results').innerHTML += output; - }); -} -// Helper function to generate HTML for a search result -function render(templateString, data) { - let conditionalMatches, conditionalPattern, copy; - conditionalPattern = /\$\{\s*isset ([a-zA-Z]*) \s*\}(.*)\$\{\s*end\s*}/g; - //since loop below depends on re.lastInxdex, we use a copy to capture any manipulations whilst inside the loop - copy = templateString; - while ( - (conditionalMatches = conditionalPattern.exec(templateString)) !== null - ) { - if (data[conditionalMatches[1]]) { - //valid key, remove conditionals, leave contents. - copy = copy.replace(conditionalMatches[0], conditionalMatches[2]); - } else { - //not valid, remove entire section - copy = copy.replace(conditionalMatches[0], ''); - } - } - templateString = copy; - - //now any conditionals removed we can do simple substitution - let key, find, re; - for (key in data) { - find = '\\$\\{\\s*' + key + '\\s*\\}'; - re = new RegExp(find, 'g'); - templateString = templateString.replace(re, data[key]); - } - return templateString; -} - -if (pathName.includes('registry')) { - document.addEventListener('DOMContentLoaded', (event) => { let languageList = document .getElementById('languageFilter') .querySelectorAll('.dropdown-item'); @@ -191,6 +108,98 @@ if (pathName.includes('registry')) { }); } +function showBody() { + document.title = originalDocumentTitle; + document.querySelector('#search-results').innerHTML = ''; + let defaultBody = document.querySelector('#default-body'); + if (defaultBody.style.display === 'none') { + defaultBody.style.display = 'block'; + } +} + +// Runs search through Fuse for fuzzy search +function executeSearch(searchQuery) { + if (searchQuery === '') { + showBody(); + return; + } + + document.title = searchQuery + ' at ' + originalDocumentTitle; + document.querySelector('#input-s').value = searchQuery; + document.querySelector('#default-body').style.display = 'none'; + document.querySelector('#search-results').innerHTML = ''; + document.getElementById('search-loading').style.display = 'block'; + + const run = function (searchQuery) { + // The 0-timeout is here if search is blocking, such that the "search loading" is rendered properly + setTimeout(() => { + let results = miniSearch.search(searchQuery); + document.getElementById('search-loading').style.display = 'none'; + + if (results.length > 0) { + populateResults(results); + } else { + document.querySelector('#search-results').innerHTML += + 'No matches found
'; + } + }, 0); + }; + + if (fetched) { + run(searchQuery); + } else { + fetch('/ecosystem/registry/index.json') + .then((res) => res.json()) + .then((json) => { + fetched = true; + miniSearch.addAll(json); + run(searchQuery); + }); + } +} + +function autoSuggest(value) { + if (value === '') { + return; + } + + const run = function (value) { + const suggestions = miniSearch.autoSuggest(value, { + // we only use title, otherwise we get strange suggestions, especially with description + fields: ['title'], + }); + const list = document.getElementById('search-suggestions'); + list.innerHTML = suggestions + .map(({ suggestion }) => ``) + .join(''); + }; + + if (fetched) { + run(value); + } else { + fetch('/ecosystem/registry/index.json') + .then((res) => res.json()) + .then((json) => { + fetched = true; + miniSearch.addAll(json); + run(value); + }); + } +} + +// Populate the search results and render to the page +function populateResults(results) { + document.querySelector('#search-results').innerHTML += results.reduce( + (acc, result) => { + return ( + acc + + document.querySelector(`[data-registry-id="${result._key}"]`).outerHTML + ); + }, + '', + ); +} + function setInput(key, value) { document.getElementById(`input-${key}`).value = value; var queryParams = new URLSearchParams(window.location.search); diff --git a/assets/scss/_registry.scss b/assets/scss/_registry.scss index 078821959705..6d6855dae410 100644 --- a/assets/scss/_registry.scss +++ b/assets/scss/_registry.scss @@ -6,6 +6,13 @@ } } + @each $component, $color in $otel-registry-license-colors { + &.badge-#{$component} { + color: white; + background-color: $color; + } + } + &.badge-elixir { color: map-get($otel-component-colors, erlang); background-color: inherit; @@ -28,3 +35,35 @@ color: color-contrast($default-otel-badge-bg); background-color: $default-otel-badge-bg; } + +.registry-entry { + @extend .shadow; +} + +// fix me: the registry seems not to load the main.min.css with the extended +// styles, so we need to define the styles here again. +.highlight { + margin: 1rem 0; + padding: 0; + position: relative; + max-width: 95%; + border: var(--bs-card-border-width) solid var(--bs-card-border-color); + border-radius: var(--bs-card-border-radius); + & pre { + padding: 1rem; + margin: 0; + display: block; + text-align: right; + overflow-y: auto; + & button.td-click-to-copy { + position: absolute; + color: #ced4da; + border-radius: 3px; + border-width: 0; + background-color: inherit; + box-shadow: 1px 1px #ced4da; + right: 4px; + top: 2px; + } + } +} diff --git a/assets/scss/_variables_project.scss b/assets/scss/_variables_project.scss index 90fc12dfcb90..83860361c271 100644 --- a/assets/scss/_variables_project.scss +++ b/assets/scss/_variables_project.scss @@ -33,6 +33,13 @@ $otel-component-colors: ( 'utilities': #2cd3b4, ); +$otel-registry-license-colors: ( + 'apache-20': #e83e8c, + 'bsd-2-clause': #8ce83e, + 'mit': #3e8ce8, + 'artistic-10-perl': #e8c83e, +); + $primary: map-get($otel-colors, 'blue'); $secondary: map-get($otel-colors, 'orange'); $td-enable-google-fonts: false; diff --git a/content/en/blog/2023/logs-collection/index.md b/content/en/blog/2023/logs-collection/index.md index 9931e65d854e..a4e3c0dc16fa 100644 --- a/content/en/blog/2023/logs-collection/index.md +++ b/content/en/blog/2023/logs-collection/index.md @@ -420,9 +420,8 @@ extend Yoda's code to do the following: [transform or attributes processors](/docs/collector/transforming-telemetry/). 1. Add [tracing](/docs/concepts/signals/traces/) support by emitting spans, where it makes sense. -1. Add an Observability backend such as OpenSearch (along with [Data - Prepper][dataprepper]) to the setup, allowing to ingest spans and logs in - OTLP format. +1. Add an Observability backend such as OpenSearch (along with [Data Prepper]) + to the setup, allowing to ingest spans and logs in OTLP format. 1. Once you have traces and logs ingested in a backend, try to correlate these two telemetry signal types in the backend along with a frontend such as Grafana. @@ -466,7 +465,7 @@ check out the following resources: [otlp]: /docs/specs/otlp/ [otelbin-yoda]: https://www.otelbin.io/?#config=receivers%3A*N__otlp%3A*N____protocols%3A*N______grpc%3A*Nexporters%3A*N__logging%3A*N____verbosity%3A_detailed*Nservice%3A*N__pipelines%3A*N____logs%3A*N______receivers%3A_%5B_otlp_%5D*N______exporters%3A_%5B_logging_%5D%7E -[dataprepper]: https://opensearch.org/docs/latest/data-prepper/index/ +[data prepper]: https://opensearch.org/docs/latest/data-prepper/index/ [svrnm]: https://github.com/svrnm [hossko]: https://github.com/hossko [otel-logs-spec]: /docs/specs/otel/logs/ diff --git a/content/en/docs/demo/feature-flags.md b/content/en/docs/demo/feature-flags.md index 28ddbb0b339e..eeca0b01bc74 100644 --- a/content/en/docs/demo/feature-flags.md +++ b/content/en/docs/demo/feature-flags.md @@ -1,6 +1,6 @@ --- title: Feature Flags -aliases: [feature_flags, ../feature_flags/] +aliases: [feature_flags] cSpell:ignore: OLJCESPC7Z --- diff --git a/content/en/docs/demo/telemetry-features/_index.md b/content/en/docs/demo/telemetry-features/_index.md index f871113d116c..ef1571fc9b6a 100644 --- a/content/en/docs/demo/telemetry-features/_index.md +++ b/content/en/docs/demo/telemetry-features/_index.md @@ -1,7 +1,7 @@ --- title: Telemetry Features linkTitle: Telemetry Features -aliases: [demo_features] +aliases: [demo_features, features] --- ## OpenTelemetry @@ -25,8 +25,8 @@ aliases: [demo_features] Grafana. - **[Jaeger](https://www.jaegertracing.io/)**: all generated traces are being sent to Jaeger. -- **[OpenSearch](https://opensearch.org/)**: all generated logs are sent to - DataPrepper. OpenSearch will be used to centralize logging data from services. +- **[OpenSearch](https://opensearch.org/)**: all generated logs are sent to Data + Prepper. OpenSearch will be used to centralize logging data from services. - **[Prometheus](https://prometheus.io/)**: all generated metrics and exemplars are scraped by Prometheus. diff --git a/content/en/docs/demo/telemetry-features/logging-features.md b/content/en/docs/demo/telemetry-features/logging-features.md index 73bb621b0192..ec91cb93678f 100644 --- a/content/en/docs/demo/telemetry-features/logging-features.md +++ b/content/en/docs/demo/telemetry-features/logging-features.md @@ -1,7 +1,7 @@ --- title: Log Coverage by Service linkTitle: Log Coverage -aliases: [log_service_features, ../log_features] +aliases: [log_service_features, ../logging-features] --- | Service | Language | OTLP Logs | diff --git a/content/en/docs/demo/telemetry-features/manual-span-attributes.md b/content/en/docs/demo/telemetry-features/manual-span-attributes.md index 8083297849cb..170d28257158 100644 --- a/content/en/docs/demo/telemetry-features/manual-span-attributes.md +++ b/content/en/docs/demo/telemetry-features/manual-span-attributes.md @@ -1,11 +1,10 @@ --- title: Manual Span Attributes -aliases: [manual_span_attributes] +aliases: [manual_span_attributes, ../manual-span-attributes] cSpell:ignore: featureflag --- -This document contains the list of manual Span Attributes used throughout the -demo: +This page lists the manual Span Attributes used throughout the demo: ## AdService diff --git a/content/en/docs/demo/telemetry-features/metric-features.md b/content/en/docs/demo/telemetry-features/metric-features.md index bd6ca6a195ea..158737b019f9 100644 --- a/content/en/docs/demo/telemetry-features/metric-features.md +++ b/content/en/docs/demo/telemetry-features/metric-features.md @@ -1,7 +1,7 @@ --- title: Metric Coverage by Service linkTitle: Metric Coverage -aliases: [metric_service_features, ../metric_features] +aliases: [metric_service_features, ../metric-features] --- | Service | Language | Auto-instrumentation | Manual Instrumentation | Multiple Instruments | Views | Custom Attributes | Resource Detection | Trace Exemplars | diff --git a/content/en/docs/demo/telemetry-features/trace-features.md b/content/en/docs/demo/telemetry-features/trace-features.md index dff6432d2eda..2b289cba428b 100644 --- a/content/en/docs/demo/telemetry-features/trace-features.md +++ b/content/en/docs/demo/telemetry-features/trace-features.md @@ -1,7 +1,7 @@ --- title: Trace Coverage by Service linkTitle: Trace Coverage -aliases: [trace_service_features, ../trace_features] +aliases: [trace_service_features, ../trace-features] --- | Service | Language | Instrumentation Libraries | Manual Span Creation | Span Data Enrichment | RPC Context Propagation | Span Links | Baggage | Resource Detection | diff --git a/content/en/docs/languages/js/libraries.md b/content/en/docs/languages/js/libraries.md index 38d4449df398..a7994d7b5894 100644 --- a/content/en/docs/languages/js/libraries.md +++ b/content/en/docs/languages/js/libraries.md @@ -6,39 +6,7 @@ description: How to instrument libraries an app depends on cSpell:ignore: autoinstrumentation metapackage metapackages --- -When you develop an app, you make use of third-party libraries and frameworks to -accelerate your work and to not reinvent the wheel. If you now instrument your -app with OpenTelemetry, you don't want to spend additional time on manually -adding traces, logs and metrics to those libraries and frameworks. Fortunately, -you don't have to reinvent the wheel for those either: libraries might come with -OpenTelemetry support natively or you can use an -[Instrumentation Library](/docs/concepts/instrumentation/libraries/) in order to -generate telemetry data for a library or framework. - -If you are instrumenting an app, you can learn on this page how to make use of -natively instrumented libraries and Instrumentation Libraries for your -dependencies. - -If you want to instrument a library, you can learn on this page what you need to -do to natively instrument your own library or how you can create an -Instrumentation Library for a third-party library if none is available. - -## Use natively instrumented libraries - -If a library comes with OpenTelemetry out of the box, you get the traces, -metrics and logs emitted from that library, by adding and setting up the -OpenTelemetry SDK with your app. - -The library may provide some additional configuration for the instrumentation. -Go to the documentation of that library to learn more. - -{{% alert title="Help wanted" color="warning" %}} - -As of today, we don't know about any JavaScript library that has OpenTelemetry -natively integrated. If you know about such a library, -[let us know](https://github.com/open-telemetry/opentelemetry.io/issues/new). - -{{% /alert %}} +{{% docs/languages/libraries-intro JavaScript %}} ## Use Instrumentation Libraries diff --git a/content/en/docs/languages/net/automatic/config.md b/content/en/docs/languages/net/automatic/config.md index 4a7af58069d6..275a231d01e2 100644 --- a/content/en/docs/languages/net/automatic/config.md +++ b/content/en/docs/languages/net/automatic/config.md @@ -3,7 +3,7 @@ title: Configuration and settings linkTitle: Configuration weight: 20 # prettier-ignore -cSpell:ignore: AZUREAPPSERVICE Bitness CLSID CORECLR dylib NETFX UNHANDLEDEXCEPTION +cSpell:ignore: AZUREAPPSERVICE Bitness CLSID CORECLR dylib NETFX PROCESSRUNTIME UNHANDLEDEXCEPTION --- ## Configuration methods @@ -95,10 +95,13 @@ for more details. The following resource detectors are included and enabled by default: -| ID | Description | Documentation | Status | -| ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| `CONTAINER` | Container detector | [Container resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Container-1.0.0-beta.3/src/OpenTelemetry.ResourceDetectors.Container/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `AZUREAPPSERVICE` | Azure App Service detector | [Azure resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Azure-1.0.0-beta.2/src/OpenTelemetry.ResourceDetectors.Azure/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| ID | Description | Documentation | Status | +| ----------------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| `AZUREAPPSERVICE` | Azure App Service detector | [Azure resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Azure-1.0.0-beta.4/src/OpenTelemetry.ResourceDetectors.Azure/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `CONTAINER` | Container detector | [Container resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Container-1.0.0-beta.5/src/OpenTelemetry.ResourceDetectors.Container/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `HOST` | Host detector | [Host resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Host-0.1.0-alpha.2/src/OpenTelemetry.ResourceDetectors.Host/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `PROCESS` | Process detector | [Process resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.Process-0.1.0-alpha.2/src/OpenTelemetry.ResourceDetectors.Process/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `PROCESSRUNTIME` | Process Runtime detector | [Process Runtime resource detector documentation](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/ResourceDetectors.ProcessRuntime-0.1.0-alpha.2/src/OpenTelemetry.ResourceDetectors.ProcessRuntime/README.md) | [Experimental](/docs/specs/otel/versioning-and-stability) | ## Propagators diff --git a/content/en/docs/languages/net/automatic/instrumentations.md b/content/en/docs/languages/net/automatic/instrumentations.md index 7804c030859a..5e0b336400a5 100644 --- a/content/en/docs/languages/net/automatic/instrumentations.md +++ b/content/en/docs/languages/net/automatic/instrumentations.md @@ -52,13 +52,14 @@ stable semantic convention. | `GRAPHQL` | [GraphQL](https://www.nuget.org/packages/GraphQL) **Not supported on .NET Framework** | ≥7.5.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `GRPCNETCLIENT` | [Grpc.Net.Client](https://www.nuget.org/packages/Grpc.Net.Client) | ≥2.52.0 & < 3.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `HTTPCLIENT` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `QUARTZ` | [Quartz](https://www.nuget.org/packages/Quartz) **Not supported on .NET Framework 4.7.1 and older** | ≥3.4.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `KAFKA` | [Confluent.Kafka](https://www.nuget.org/packages/Confluent.Kafka) | ≥1.4.0 < 3.0.0 | bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MASSTRANSIT` | [MassTransit](https://www.nuget.org/packages/MassTransit) **Not supported on .NET Framework** | ≥8.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MONGODB` | [MongoDB.Driver.Core](https://www.nuget.org/packages/MongoDB.Driver.Core) | ≥2.13.3 & < 3.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MYSQLCONNECTOR` | [MySqlConnector](https://www.nuget.org/packages/MySqlConnector) | ≥2.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `MYSQLDATA` | [MySql.Data](https://www.nuget.org/packages/MySql.Data) **Not supported on .NET Framework** | ≥8.1.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `NPGSQL` | [Npgsql](https://www.nuget.org/packages/Npgsql) | ≥6.0.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `NSERVICEBUS` | [NServiceBus](https://www.nuget.org/packages/NServiceBus) | ≥8.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `QUARTZ` | [Quartz](https://www.nuget.org/packages/Quartz) **Not supported on .NET Framework 4.7.1 and older** | ≥3.4.0 | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `SQLCLIENT` | [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient), [System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient) and `System.Data` (shipped with .NET Framework) | \* \[4\] | source | [Experimental](/docs/specs/otel/versioning-and-stability) | | `STACKEXCHANGEREDIS` | [StackExchange.Redis](https://www.nuget.org/packages/StackExchange.Redis) **Not supported on .NET Framework** | ≥2.0.405 < 3.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | | `WCFCLIENT` | WCF | \* | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | @@ -81,14 +82,14 @@ to [issue](https://github.com/open-telemetry/opentelemetry-dotnet/issues/4243). stable, but particular instrumentation are in Experimental status due to lack of stable semantic convention. -| ID | Instrumented library | Documentation | Supported versions | Instrumentation type | Status | -| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -------------------- | --------------------------------------------------------- | -| `ASPNET` | ASP.NET Framework \[1\] **Not supported on .NET** | [ASP.NET metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.AspNet-1.0.0-rc9.9/src/OpenTelemetry.Instrumentation.AspNet/README.md#list-of-metrics-produced) | \* | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `ASPNETCORE` | ASP.NET Core \[2\] **Not supported on .NET Framework** | [ASP.NET Core metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.5.0/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `HTTPCLIENT` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | [HttpClient metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.5.0/src/OpenTelemetry.Instrumentation.Http/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `NETRUNTIME` | [OpenTelemetry.Instrumentation.Runtime](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Runtime) | [Runtime metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Runtime-1.5.1/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `PROCESS` | [OpenTelemetry.Instrumentation.Process](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Process) | [Process metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Process-0.5.0-beta.3/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | -| `NSERVICEBUS` | [NServiceBus](https://www.nuget.org/packages/NServiceBus) | [NServiceBus metrics](https://docs.particular.net/samples/open-telemetry/prometheus-grafana/#reporting-metric-values) | ≥8.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | +| ID | Instrumented library | Documentation | Supported versions | Instrumentation type | Status | +| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | -------------------- | --------------------------------------------------------- | +| `ASPNET` | ASP.NET Framework \[1\] **Not supported on .NET** | [ASP.NET metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.AspNet-1.7.0-beta.1/src/OpenTelemetry.Instrumentation.AspNet/README.md#list-of-metrics-produced) | \* | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `ASPNETCORE` | ASP.NET Core \[2\] **Not supported on .NET Framework** | [ASP.NET Core metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/Instrumentation.AspNetCore-1.7.0/src/OpenTelemetry.Instrumentation.AspNetCore/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `HTTPCLIENT` | [System.Net.Http.HttpClient](https://docs.microsoft.com/dotnet/api/system.net.http.httpclient) and [System.Net.HttpWebRequest](https://docs.microsoft.com/dotnet/api/system.net.httpwebrequest) | [HttpClient metrics](https://github.com/open-telemetry/opentelemetry-dotnet/blob/Instrumentation.Http-1.7.0/src/OpenTelemetry.Instrumentation.Http/README.md#list-of-metrics-produced) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `NETRUNTIME` | [OpenTelemetry.Instrumentation.Runtime](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Runtime) | [Runtime metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Runtime-1.7.0/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `PROCESS` | [OpenTelemetry.Instrumentation.Process](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Process) | [Process metrics](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/Instrumentation.Process-0.5.0-beta.4/src/OpenTelemetry.Instrumentation.Process/README.md#metrics) | \* | source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `NSERVICEBUS` | [NServiceBus](https://www.nuget.org/packages/NServiceBus) | [NServiceBus metrics](https://docs.particular.net/samples/open-telemetry/prometheus-grafana/#reporting-metric-values) | ≥8.0.0 | source & bytecode | [Experimental](/docs/specs/otel/versioning-and-stability) | \[1\]: The ASP.NET metrics are generated only if the `AspNet` trace instrumentation is also enabled. @@ -102,7 +103,7 @@ instrumentation is also enabled. | ID | Instrumented library | Supported versions | Instrumentation type | Status | | --------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -------------------- | --------------------------------------------------------- | -| `ILOGGER` | [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging) **Not supported on .NET Framework** | ≥6.0.0 | bytecode or source | [Experimental](/docs/specs/otel/versioning-and-stability) | +| `ILOGGER` | [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging) **Not supported on .NET Framework** | ≥8.0.0 | bytecode or source | [Experimental](/docs/specs/otel/versioning-and-stability) | For ASP.NET Core applications, the `LoggingBuilder` instrumentation can be enabled without using the .NET CLR Profiler by setting the diff --git a/content/en/docs/languages/php/_index.md b/content/en/docs/languages/php/_index.md index e1b3c00f1403..fecc5f8e1b4e 100644 --- a/content/en/docs/languages/php/_index.md +++ b/content/en/docs/languages/php/_index.md @@ -4,7 +4,7 @@ description: >-
A language-specific implementation of OpenTelemetry in PHP.
weight: 21
-cSpell:ignore: mbstring opcache packagist
+cSpell:ignore: mbstring opcache
---
{{% docs/languages/index-intro php /%}}
diff --git a/content/en/docs/languages/php/automatic.md b/content/en/docs/languages/php/automatic.md
index 57da16d203ef..1be02f687429 100644
--- a/content/en/docs/languages/php/automatic.md
+++ b/content/en/docs/languages/php/automatic.md
@@ -3,7 +3,7 @@ title: Automatic Instrumentation
linkTitle: Automatic
weight: 30
# prettier-ignore
-cSpell:ignore: centos configurator democlass epel myapp packagist pecl phar remi unindented userland
+cSpell:ignore: centos configurator democlass epel myapp pecl phar remi unindented userland
---
Automatic instrumentation with PHP requires at least PHP 8.0, and the
diff --git a/content/en/docs/languages/ruby/libraries.md b/content/en/docs/languages/ruby/libraries.md
index f5292cbe9150..3c86db788120 100644
--- a/content/en/docs/languages/ruby/libraries.md
+++ b/content/en/docs/languages/ruby/libraries.md
@@ -1,40 +1,12 @@
---
title: Using instrumentation libraries
-linkTitle: Library
+linkTitle: Libraries
aliases: [configuring_automatic_instrumentation, automatic]
cSpell:ignore: faraday metapackage sinatra
weight: 30
---
-When you develop an app, you make use of third-party libraries and frameworks to
-accelerate your work and to not reinvent the wheel. If you now instrument your
-app with OpenTelemetry, you don't want to spend additional time on manually
-adding traces, logs and metrics to those libraries and frameworks. Fortunately,
-you don't have to reinvent the wheel for those either: libraries might come with
-OpenTelemetry support natively or you can use an
-[Instrumentation Library](/docs/concepts/instrumentation/libraries/) in order to
-generate telemetry data for a library or framework.
-
-If you are instrumenting an app, you can learn on this page how to make use of
-natively instrumented libraries and Instrumentation Libraries for your
-dependencies.
-
-## Use natively instrumented libraries
-
-If a library comes with OpenTelemetry out of the box, you get the traces,
-metrics and logs emitted from that library, by adding and setting up the
-OpenTelemetry SDK with your app.
-
-The library may provide some additional configuration for the instrumentation.
-Go to the documentation of that library to learn more.
-
-{{% alert title="Help wanted" color="warning" %}}
-
-As of today, we don't know about any Ruby library that has OpenTelemetry
-natively integrated. If you know about such a library,
-[let us know](https://github.com/open-telemetry/opentelemetry.io/issues/new).
-
-{{% /alert %}}
+{{% docs/languages/libraries-intro Ruby %}}
## Use Instrumentation Libraries
diff --git a/content/en/ecosystem/registry/_index.md b/content/en/ecosystem/registry/_index.md
index f240daab6d7d..e3e00247be74 100644
--- a/content/en/ecosystem/registry/_index.md
+++ b/content/en/ecosystem/registry/_index.md
@@ -1,8 +1,8 @@
---
title: Registry
description: >-
- Find libraries, plugins, integrations, and other useful tools for extending
- OpenTelemetry.
+ Find libraries, plugins, integrations, and other useful tools for using and
+ extending OpenTelemetry.
# The redirects and aliases implement catch-all rules for old registry entries;
# we don't publish individual entry pages anymore.
#
@@ -19,7 +19,7 @@ body_class: registry
weight: 20
---
-{{% blocks/lead color="white" %}}
+{{% blocks/lead color="dark" %}}
@@ -29,25 +29,8 @@ weight: 20
{{% /blocks/lead %}}
-{{% blocks/section color="dark" %}}
-
-## What do you need?
-
-The OpenTelemetry Registry allows you to search for instrumentation libraries,
-tracer implementations, utilities, and other useful projects in the
-OpenTelemetry ecosystem.
-
-- Not able to find an exporter for your language? Remember, the
- [OpenTelemetry Collector](/docs/collector) supports exporting to a variety of
- systems and works with all OpenTelemetry Core Components!
-- Are you a project maintainer? See,
- [Adding a project to the OpenTelemetry Registry](adding).
-- Check back regularly, the community and registry are growing!
-
-{{% /blocks/section %}}
-
{{< blocks/section color="white" type="container-lg" >}}
-{{+ + by + {{ range $index, $author := .authors -}} + {{ if $index }}, {{ end }} + {{ if eq $author.name "OpenTelemetry Authors" -}} + 🔭 {{ $author.name }} 🔭 + {{ else if isset $author "url" }} + {{ $href := printf "href=%q" $author.url | safeHTMLAttr -}} + {{ $author.name }} + {{ else -}} + {{ $author.name -}} + {{ end -}} + {{ end -}} + +
+{{ (partial .installTemplate .) | markdownify -}} +
+ {{- end -}} +