diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 000000000..30672f8e7 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,7 @@ +# Default state for all rules +default: true + +# allow long lines for tables and code blocks +MD013: + code_blocks: false + tables: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a34f8ad2..9db97b2ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,14 +76,12 @@ helper methods. in each framework that you target. * Add the following lines to your csproj: - ```xml ``` - * Use [IntelliSense](https://docs.microsoft.com/visualstudio/ide/using-intellisense) diff --git a/docs/metrics/customizing-the-sdk/README.md b/docs/metrics/customizing-the-sdk/README.md index 94e08d5a8..f902cd44f 100644 --- a/docs/metrics/customizing-the-sdk/README.md +++ b/docs/metrics/customizing-the-sdk/README.md @@ -241,7 +241,6 @@ are then aggregated using the custom boundaries provided instead of the the default boundaries. This requires the use of `ExplicitBucketHistogramConfiguration`. - ```csharp // Change Histogram boundaries to count measurements under the following buckets: // (-inf, 10] @@ -258,7 +257,6 @@ default boundaries. This requires the use of instrumentName: "MyHistogram", new ExplicitBucketHistogramConfiguration { Boundaries = new double[] { } }) ``` - ```csharp // Advanced selection criteria and config via Func @@ -343,7 +341,6 @@ There are two total `MetricStream`s created one for each of these instruments. SDK will limit the maximum number of distinct key/value combinations for each of these `MetricStream`s to `3`. - ```csharp using System.Collections.Generic; using System.Diagnostics.Metrics; @@ -397,7 +394,6 @@ AnotherFruitCounter.Add(2, new("name", "banana"), new("color", "green")); // Not AnotherFruitCounter.Add(5, new("name", "banana"), new("color", "yellow")); // Exported AnotherFruitCounter.Add(4, new("name", "mango"), new("color", "yellow")); // Not exported ``` - **NOTE:** The above limit is *per* metric stream, and applies to all the metric streams. There is no ability to apply different limits for each instrument at diff --git a/docs/metrics/getting-started/README.md b/docs/metrics/getting-started/README.md index d31a802a8..789c519b7 100644 --- a/docs/metrics/getting-started/README.md +++ b/docs/metrics/getting-started/README.md @@ -31,7 +31,6 @@ Run the application again (using `dotnet run`) and you should see the metric output from the console (metrics will be seen once the program ends), similar to shown below: - ```text Export MyFruitCounter, Meter: MyCompany.MyProduct.MyLibrary/1.0 (2021-09-23T22:00:08.4399776Z, 2021-09-23T22:00:08.4510115Z] color:red name:apple LongSum @@ -41,7 +40,6 @@ Value: 7 (2021-09-23T22:00:08.4399776Z, 2021-09-23T22:00:08.4510115Z] color:green name:apple LongSum Value: 2 ``` - Congratulations! You are now collecting metrics using OpenTelemetry. diff --git a/docs/trace/reporting-exceptions/README.md b/docs/trace/reporting-exceptions/README.md index 38bbc9699..7c85a4614 100644 --- a/docs/trace/reporting-exceptions/README.md +++ b/docs/trace/reporting-exceptions/README.md @@ -145,7 +145,6 @@ one possible way of doing this: **WARNING:** Use `AppDomain.UnhandledException` with caution. A throw in the handler puts the process into an unrecoverable state. - ```csharp using System; using System.Diagnostics; @@ -191,4 +190,3 @@ public class Program } } ``` - diff --git a/src/OpenTelemetry.Api/README.md b/src/OpenTelemetry.Api/README.md index e29f1dc19..aa3958c4d 100644 --- a/src/OpenTelemetry.Api/README.md +++ b/src/OpenTelemetry.Api/README.md @@ -460,13 +460,11 @@ for versions lower than `.NET Framework 4.6.1`. 1. Install the `System.Diagnostics.DiagnosticSource` package version `6.0.0` or above to your application or library. - ```xml ``` - 2. Create a `Meter`, providing the name and version of the library/application doing the instrumentation. The `Meter` instance is typically created once and diff --git a/src/OpenTelemetry.Exporter.Jaeger/README.md b/src/OpenTelemetry.Exporter.Jaeger/README.md index 0d0382619..a282f64bb 100644 --- a/src/OpenTelemetry.Exporter.Jaeger/README.md +++ b/src/OpenTelemetry.Exporter.Jaeger/README.md @@ -78,14 +78,12 @@ The following environment variables can be used to override the default values of the `JaegerExporterOptions` (following the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#jaeger-exporter)). - | Environment variable | `JaegerExporterOptions` property | |-----------------------------------|-----------------------------------------------------------| | `OTEL_EXPORTER_JAEGER_AGENT_HOST` | `AgentHost` | | `OTEL_EXPORTER_JAEGER_AGENT_PORT` | `AgentPort` | | `OTEL_EXPORTER_JAEGER_ENDPOINT` | `Endpoint` | | `OTEL_EXPORTER_JAEGER_PROTOCOL` | `Protocol` (`udp/thrift.compact` or `http/thrift.binary`) | - `FormatException` is thrown in case of an invalid value for any of the supported environment variables. diff --git a/src/OpenTelemetry/README.md b/src/OpenTelemetry/README.md index 684f6e5d6..be7d9a49c 100644 --- a/src/OpenTelemetry/README.md +++ b/src/OpenTelemetry/README.md @@ -206,14 +206,12 @@ purposes, the SDK provides the following built-in processors: The following environment variables can be used to override the default values of the `BatchExportActivityProcessorOptions`. - | Environment variable | `BatchExportActivityProcessorOptions` property | | -------------------------------- | ---------------------------------------------- | | `OTEL_BSP_SCHEDULE_DELAY` | `ScheduledDelayMilliseconds` | | `OTEL_BSP_EXPORT_TIMEOUT` | `ExporterTimeoutMilliseconds` | | `OTEL_BSP_MAX_QUEUE_SIZE` | `MaxQueueSize` | | `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` | `MaxExportBatchSizeEnvVarKey` | - `FormatException` is thrown in case of an invalid value for any of the supported environment variables. @@ -265,12 +263,10 @@ using var tracerProvider = Sdk.CreateTracerProviderBuilder() It is also possible to configure the `Resource` by using following environmental variables: - | Environment variable | Description | | -------------------------- | -------------------------------------------------- | | `OTEL_RESOURCE_ATTRIBUTES` | Key-value pairs to be used as resource attributes. See the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/resource/sdk.md#specifying-resource-information-via-an-environment-variable) for more details. | | `OTEL_SERVICE_NAME` | Sets the value of the `service.name` resource attribute. If `service.name` is also provided in `OTEL_RESOURCE_ATTRIBUTES`, then `OTEL_SERVICE_NAME` takes precedence. | - ### Sampler diff --git a/test/Benchmarks/README.md b/test/Benchmarks/README.md index 2dac7ab5c..0838bd1fd 100644 --- a/test/Benchmarks/README.md +++ b/test/Benchmarks/README.md @@ -5,8 +5,6 @@ Use the following example to run Benchmarks from command line: Navigate to `./test/Benchmarks` directory and run the following command: - ```sh dotnet run --framework net6.0 --configuration Release --filter *TraceBenchmarks* ``` - diff --git a/test/OpenTelemetry.Tests.Stress/README.md b/test/OpenTelemetry.Tests.Stress/README.md index 00d2ff247..4b7b10ddb 100644 --- a/test/OpenTelemetry.Tests.Stress/README.md +++ b/test/OpenTelemetry.Tests.Stress/README.md @@ -30,7 +30,6 @@ Use the `ENTER` key to print the latest performance statistics. Use the `ESC` key to exit the stress test. - ```text Running (concurrency = 1), press to stop... 2021-09-28T18:47:17.6807622Z Loops: 17,549,732,467, Loops/Second: 738,682,519, CPU Cycles/Loop: 3 @@ -40,7 +39,6 @@ Running (concurrency = 1), press to stop... 2021-09-28T18:47:18.5052989Z Loops: 18,150,598,194, Loops/Second: 733,026,161, CPU Cycles/Loop: 3 2021-09-28T18:47:18.7116733Z Loops: 18,299,461,007, Loops/Second: 724,950,210, CPU Cycles/Loop: 3 ``` - The stress test metrics are exposed via [PrometheusExporter](../../src/OpenTelemetry.Exporter.Prometheus/README.md),