Skip to content

Commit

Permalink
Update Changelog and MongoDB docs (#635)
Browse files Browse the repository at this point in the history
* Update docs

* configure md024 rule

* Update CHANGELOG.md

Co-authored-by: Piotr Kiełkowicz <[email protected]>

Co-authored-by: Piotr Kiełkowicz <[email protected]>
Co-authored-by: Paulo Janotti <[email protected]>
  • Loading branch information
3 people authored Apr 28, 2022
1 parent 349674b commit cfa6ee4
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
9 changes: 8 additions & 1 deletion .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Default state for all rules
default: true

# allow long lines for tables and code blocks
# Configure long lines for tables and code blocks
MD013:
code_blocks: false
tables: false

# Configure Multiple headings with the same content
MD024:
# Only check sibling headings
allow_different_nesting: true
# Only check sibling headings
siblings_only: true
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## [Unreleased](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/compare/v0.1.0-beta.1...HEAD)

### Added

- Adds MongoDB instrumentation support from .NET Core 3.1+.

## [0.1.0-beta.1](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/releases/tag/v0.1.0-beta.1)

The is an initial, official beta release,
Expand Down
14 changes: 8 additions & 6 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ for more details.

### Instrumented libraries and frameworks

| ID | Library | Instrumentation type |
|-|-|-|
| `AspNet` | ASP.NET and ASP.NET Core | source |
| `GraphQL` | [GraphQL](https://www.nuget.org/packages/GraphQL/) | bytecode |
| `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 |
| `SqlClient` | [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient) and [System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient) | source |
| ID | Library | Supported versions | Instrumentation type |
|-|-|-|-|
| `AspNet` | ASP.NET MVC Framework | * | source |
| `AspNet` | ASP.NET Core | * | source |
| `GraphQL` | [GraphQL](https://www.nuget.org/packages/GraphQL/) | ≥2.3.0 & < 3.0.0 | bytecode |
| `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 |
| `MongoDb` | [MongoDB.Driver.Core](https://www.nuget.org/packages/MongoDB.Driver.Core) | ≥2.3.0 & < 3.0.0 | source & bytecode |
| `SqlClient` | [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient) and [System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient) | * | source |

## ASP.NET (.NET Framework) Instrumentation

Expand Down

0 comments on commit cfa6ee4

Please sign in to comment.