Update docs

Author: MattKotsenas

src/OpenTelemetry.Instrumentation.Kusto/CHANGELOG.md

@@ -2,4 +2,4 @@
 
 ## Unreleased
 
-* Initial implementation of Kusto instrumentation.
+* Initial implementation.

src/OpenTelemetry.Instrumentation.Kusto/README.md

@@ -1,7 +1,7 @@
 # Kusto Instrumentation for OpenTelemetry
 
-| Status      |           |
-| ----------- | --------- |
+| Status      |                                |
+| ----------- | ------------------------------ |
 | Stability   | [Alpha](../../README.md#alpha) |
 
 [![NuGet version badge](https://img.shields.io/nuget/v/OpenTelemetry.Instrumentation.Kusto)](https://www.nuget.org/packages/OpenTelemetry.Instrumentation.Kusto)
@@ -81,12 +81,12 @@ The instrumentation is implemented based on [metrics semantic
 conventions](https://github.com/open-telemetry/semantic-conventions/blob/v1.36.0/docs/database/database-metrics.md).
 Currently, the instrumentation supports the following metric:
 
-| Name                           | Instrument Type | Unit | Description                             | Attributes |
-|--------------------------------|-----------------|------|-----------------------------------------|------------|
-| `db.client.operation.duration` | Histogram       | `s`  | Duration of database client operations. | `db.system`, `db.operation.name`, `db.namespace`, `db.query.summary`¹, `server.address`, `server.port`, `error.type`² |
+| Name                           | Instrument Type | Unit | Description                             | Attributes                                                                                                                 |
+|--------------------------------|-----------------|------|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
+| `db.client.operation.duration` | Histogram       | `s`  | Duration of database client operations. | `db.system`, `db.operation.name`, `db.namespace`, `db.query.summary` (1), `server.address`, `server.port`, `error.type`(2) |
 
-¹ `db.query.summary` is only included when `RecordQuerySummary` is enabled (default: `true`)
-² `error.type` is only included when an error occurs
+1 `db.query.summary` is only included when `RecordQuerySummary` is enabled
+2 `error.type` is only included when an error occurs
 
 ## Advanced configuration
 
@@ -142,8 +142,8 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder()
     .AddKustoInstrumentation(opt => opt.Enrich = (activity, record) =>
     {
         // Add custom tags based on the TraceRecord
-        activity.SetTag("kusto.activity_id", record.Activity.ActivityId);
-        activity.SetTag("kusto.activity_type", record.Activity.ActivityType);
+        activity.SetTag("azure.kusto.activity_id", record.Activity.ActivityId);
+        activity.SetTag("azure.kusto.activity_type", record.Activity.ActivityType);
     })
     .Build();
 ```
@@ -205,7 +205,8 @@ Users
 | take 100
 ```
 
-Would result in an activity with the summary and display name set to `"Get active users"`.
+Would result in an activity with the summary and display name
+set to `"Get active users"`.
 
 ## References
 

test/OpenTelemetry.Instrumentation.Kusto.Benchmarks/README.md

@@ -14,13 +14,14 @@ Then choose the benchmark class that you want to run by entering the required
 option number from the list of options shown on the Console window.
 
 > [!TIP]
-> The Profiling benchmarks are designed to run quickly and use the Visual Studio diagnosers to gather performance data.
+> The Profiling benchmarks are designed to run quickly and use the Visual
+> Studio diagnosers to gather performance data.
 
 ## Results
 
 ### Full instrumentation
 
-```
+```plain
 
 BenchmarkDotNet v0.15.6, Windows 11 (10.0.26200.7093)
 Intel Core Ultra 7 165H 3.80GHz, 1 CPU, 22 logical and 16 physical cores
@@ -30,19 +31,20 @@ Intel Core Ultra 7 165H 3.80GHz, 1 CPU, 22 logical and 16 physical cores
 
 
 ```
+
 | Method             | Mean      | Error     | StdDev    | Gen0   | Gen1   | Allocated |
 |------------------- |----------:|----------:|----------:|-------:|-------:|----------:|
-| SuccessfulQuery    |  9.043 μs | 0.1183 μs | 0.1048 μs | 0.9308 | 0.0153 |  11.48 KB |
-| FailedQuery        | 10.076 μs | 0.2007 μs | 0.3354 μs | 0.9613 | 0.0153 |  11.91 KB |
-| TraceListenerOnly  |  9.411 μs | 0.1788 μs | 0.2325 μs | 0.9308 | 0.0153 |  11.52 KB |
-| MetricListenerOnly |  9.352 μs | 0.1746 μs | 0.2613 μs | 0.9308 | 0.0153 |  11.52 KB |
+| SuccessfulQuery    |  9.043 us | 0.1183 us | 0.1048 us | 0.9308 | 0.0153 |  11.48 KB |
+| FailedQuery        | 10.076 us | 0.2007 us | 0.3354 us | 0.9613 | 0.0153 |  11.91 KB |
+| TraceListenerOnly  |  9.411 us | 0.1788 us | 0.2325 us | 0.9308 | 0.0153 |  11.52 KB |
+| MetricListenerOnly |  9.352 us | 0.1746 us | 0.2613 us | 0.9308 | 0.0153 |  11.52 KB |
 
 ### Summarization and sanitization processing
 
-Summarization and sanitization are the most expensive parts of instrumentation, so there are benchmarks to measure their
-specific cost.
+Summarization and sanitization are the most expensive parts of instrumentation, so
+there are benchmarks to measure their specific cost.
 
-```
+```plain
 
 BenchmarkDotNet v0.15.6, Windows 11 (10.0.26200.7093)
 Intel Core Ultra 7 165H 3.80GHz, 1 CPU, 22 logical and 16 physical cores
@@ -52,9 +54,10 @@ Intel Core Ultra 7 165H 3.80GHz, 1 CPU, 22 logical and 16 physical cores
 
 
 ```
+
 | Method                      | Mean      | Error     | StdDev    | Gen0   | Gen1   | Allocated |
 |---------------------------- |----------:|----------:|----------:|-------:|-------:|----------:|
-| ProcessSummarizeAndSanitize | 10.141 μs | 0.1926 μs | 0.2436 μs | 1.0834 | 0.0153 |  13.36 KB |
-| ProcessSummarizeOnly        |  9.549 μs | 0.1772 μs | 0.1571 μs | 1.0071 | 0.0153 |  12.48 KB |
-| ProcessSanitizeOnly         |  4.154 μs | 0.0827 μs | 0.1832 μs | 0.5798 | 0.0038 |   7.13 KB |
+| ProcessSummarizeAndSanitize | 10.141 us | 0.1926 us | 0.2436 us | 1.0834 | 0.0153 |  13.36 KB |
+| ProcessSummarizeOnly        |  9.549 us | 0.1772 us | 0.1571 us | 1.0071 | 0.0153 |  12.48 KB |
+| ProcessSanitizeOnly         |  4.154 us | 0.0827 us | 0.1832 us | 0.5798 | 0.0038 |   7.13 KB |
 | ProcessNeither              | 0.0566 ns | 0.0259 ns | 0.0610 ns |      - |      - |         - |

test/OpenTelemetry.Instrumentation.Kusto.Tests/OpenTelemetry.Instrumentation.Kusto.Tests.csproj

@@ -34,7 +34,7 @@
     <!--
       Verify adds an implicit using for the test framework, however because we use shared files, remove it to avoid
       an unnecessary using warning.
-     -->
+    -->
     <Using Remove="Xunit" />
   </ItemGroup>