open-telemetry
/
opentelemetry-dotnet
mirror of https://github.com/open-telemetry/opentelemetry-dotnet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add VS Code recommended spell check extension (#3127)

This commit is contained in:
Travis Illig 2022-04-06 08:35:38 -07:00 committed by GitHub
parent 4e2437cfcd
commit d294140a33
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
25 changed files with 93 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/ISSUE_TEMPLATE/question.md vendored
View File

@ -1,10 +1,9 @@
---
name: Question
about: Create a question to help us improve our knowledgebase and documentation
about: Create a question to help us improve our knowledge base and documentation
labels: question
---
# Question
Use [Github Discussions](https://github.com/open-telemetry/opentelemetry-dotnet/discussions/new).

3
.vscode/extensions.json vendored
View File

@ -2,6 +2,7 @@
"recommendations": [
"editorconfig.editorconfig",
"davidanson.vscode-markdownlint",
"ms-dotnettools.csharp"
"ms-dotnettools.csharp",
"streetsidesoftware.code-spell-checker"
]
}

48
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,48 @@
{
"cSpell.words": [
"asax",
"cijo",
"cncf",
"codebases",
"codecov",
"contoso",
"cref",
"grafana",
"janotti",
"kanzhelev",
"liudmila",
"mikel",
"molkova",
"monocytogenes",
"nakamura",
"netcoreapp",
"netfx",
"netstandard",
"nupkg",
"oneof",
"opentelemetry",
"otel",
"otlp",
"paulo",
"pillai",
"proto",
"protobuf",
"protos",
"reiley",
"rpcz",
"ruleset",
"runtimes",
"sergey",
"struct",
"tbody",
"thead",
"triager",
"umesan",
"unencrypted",
"unvalidated",
"utkarsh",
"xunit",
"zipkin",
"zpages"
]
}

2
CONTRIBUTING.md
View File

@ -211,6 +211,6 @@ This project includes a [`.editorconfig`](./.editorconfig) file which is
supported by all the IDEs/editor mentioned above. It works with the IDE/editor
only and does not affect the actual build of the project.
This repository also includes stylecop ruleset files under the `./build` folder.
This repository also includes StyleCop ruleset files under the `./build` folder.
These files are used to configure the _StyleCop.Analyzers_ which runs during
build. Breaking the rules will result in a build failure.

2
docs/metrics/customizing-the-sdk/README.md
View File

@ -295,7 +295,7 @@ allowed to be `1`. This means that the SDK would export measurements from only
one `MetricStream`. The very first instrument that is published
(`MyFruitCounter` in this case) will create a `MetricStream` and the SDK will
thereby reach the maximum `MetricStream` limit of `1`. The measurements from any
susequent instruments added will be dropped.
subsequent instruments added will be dropped.
```csharp
using System.Diagnostics.Metrics;

2
docs/trace/extending-the-sdk/MyEnrichingProcessor.cs
View File

@ -22,7 +22,7 @@ internal class MyEnrichingProcessor : BaseProcessor<Activity>
public override void OnEnd(Activity activity)
{
// Enrich activity with additional tags.
activity.SetTag("mycustomTag", "myCustomTagValue");
activity.SetTag("myCustomTag", "myCustomTagValue");
// Enriching from Baggage.
// The below snippet adds every Baggage item.

2
src/OpenTelemetry.Api/CHANGELOG.md
View File

@ -170,7 +170,7 @@ Released 2020-Nov-5
([#1413](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1413))
* Moving grpc status and helper to grpc project
([#1422](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1422))
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropapagor to
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropagator to
CompositeTextMapPropagator. IPropagator is renamed to TextMapPropagator and
changed from interface to abstract class.
([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))

4
src/OpenTelemetry.Exporter.Jaeger/CHANGELOG.md
View File

@ -72,7 +72,7 @@ Released 2021-Sep-13
`BatchExportActivityProcessorOptions` which supports field value overriding
using `OTEL_BSP_SCHEDULE_DELAY`, `OTEL_BSP_EXPORT_TIMEOUT`,
`OTEL_BSP_MAX_QUEUE_SIZE`, `OTEL_BSP_MAX_EXPORT_BATCH_SIZE`
envionmental variables as defined in the
environmental variables as defined in the
[specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/sdk-environment-variables.md#batch-span-processor).
([#2219](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2219))
@ -89,7 +89,7 @@ Released 2021-Jul-23
* The `JaegerExporterOptions` defaults can be overridden using
`OTEL_EXPORTER_JAEGER_AGENT_HOST` and `OTEL_EXPORTER_JAEGER_AGENT_PORT`
envionmental variables as defined in the
environmental variables as defined in the
[specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#jaeger-exporter).
([#2123](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2123))

2
src/OpenTelemetry.Exporter.OpenTelemetryProtocol/CHANGELOG.md
View File

@ -219,7 +219,7 @@ Released 2021-Feb-04
Released 2021-Jan-29
* Changed `OltpTraceExporter` class and constructor from internal to public.
* Changed `OtlpTraceExporter` class and constructor from internal to public.
([#1612](https://github.com/open-telemetry/opentelemetry-dotnet/issues/1612))
* In `OtlpExporterOptions.cs`: Exporter options now include a switch for Batch

6
src/OpenTelemetry.Exporter.OpenTelemetryProtocol/Implementation/ResourceExtensions.cs
View File

@ -30,10 +30,10 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Implementation
foreach (KeyValuePair<string, object> attribute in resource.Attributes)
{
var oltpAttribute = attribute.ToOtlpAttribute();
if (oltpAttribute != null)
var otlpAttribute = attribute.ToOtlpAttribute();
if (otlpAttribute != null)
{
processResource.Attributes.Add(oltpAttribute);
processResource.Attributes.Add(otlpAttribute);
}
}

2
src/OpenTelemetry.Exporter.ZPages/ZPagesExporterOptions.cs
View File

@ -22,7 +22,7 @@ namespace OpenTelemetry.Exporter.ZPages
public class ZPagesExporterOptions
{
/// <summary>
/// Gets or sets the port to listen to. Typically it ends with /rpcz like http://localhost:7284/rpcz/.
/// Gets or sets the URL to listen to. Typically it ends with /rpcz like http://localhost:7284/rpcz/.
/// </summary>
public string Url { get; set; }

2
src/OpenTelemetry.Exporter.ZPages/ZPagesProcessor.cs
View File

@ -31,7 +31,7 @@ namespace OpenTelemetry.Exporter.ZPages
/// <summary>
/// Initializes a new instance of the <see cref="ZPagesProcessor"/> class.
/// </summary>
/// <param name="exporter">Zpage Span processor instance.</param>
/// <param name="exporter">Zpages Span processor instance.</param>
public ZPagesProcessor(ZPagesExporter exporter)
{
this.exporter = exporter;

2
src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md
View File

@ -61,7 +61,7 @@ Released 2021-Sep-13
`BatchExportActivityProcessorOptions` which supports field value overriding
using `OTEL_BSP_SCHEDULE_DELAY`, `OTEL_BSP_EXPORT_TIMEOUT`,
`OTEL_BSP_MAX_QUEUE_SIZE`, `OTEL_BSP_MAX_EXPORT_BATCH_SIZE`
envionmental variables as defined in the
environmental variables as defined in the
[specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/sdk-environment-variables.md#batch-span-processor).
([#2219](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2219))

2
src/OpenTelemetry.Instrumentation.AspNet.TelemetryHttpModule/AspNetTelemetryEventSource.cs
View File

@ -102,7 +102,7 @@ namespace OpenTelemetry.Instrumentation.AspNet
}
[Event(5, Message = "Failed to invoke OnExecuteRequestStep, Error='{0}'", Level = EventLevel.Error)]
public void OnExecuteRequestStepInvokationError(string error)
public void OnExecuteRequestStepInvocationError(string error)
{
this.WriteEvent(5, error);
}

4
src/OpenTelemetry.Instrumentation.AspNet.TelemetryHttpModule/TelemetryHttpModule.cs
View File

@ -70,7 +70,7 @@ namespace OpenTelemetry.Instrumentation.AspNet
}
catch (Exception e)
{
AspNetTelemetryEventSource.Log.OnExecuteRequestStepInvokationError(e.Message);
AspNetTelemetryEventSource.Log.OnExecuteRequestStepInvocationError(e.Message);
}
}
}
@ -108,7 +108,7 @@ namespace OpenTelemetry.Instrumentation.AspNet
// When the child request completes, the parent request executes the end request notifications and completes itself.
// Do not create activity for parent request. Parent request has IIS_UrlRewriteModule ServerVariable with success response code.
// Child request contains an additional ServerVariable named - IIS_WasUrlRewritten.
// Track failed response activity: Different modules in the pipleline has ability to end the response. For example, authentication module could set HTTP 401 in OnBeginRequest and end the response.
// Track failed response activity: Different modules in the pipeline has ability to end the response. For example, authentication module could set HTTP 401 in OnBeginRequest and end the response.
if (context.Request.ServerVariables != null && context.Request.ServerVariables[URLRewriteRewrittenRequest] == null && context.Request.ServerVariables[URLRewriteModuleVersion] != null && context.Response.StatusCode == 200)
{
trackActivity = false;

2
src/OpenTelemetry.Instrumentation.AspNet/CHANGELOG.md
View File

@ -89,7 +89,7 @@ Released 2020-Nov-17
Released 2020-Nov-5
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropapagor to
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropagator to
CompositeTextMapPropagator. IPropagator is renamed to TextMapPropagator and
changed from interface to abstract class.
([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))

2
src/OpenTelemetry.Instrumentation.AspNetCore/CHANGELOG.md
View File

@ -95,7 +95,7 @@ Released 2020-Nov-5
[Grpc.AspNetCore](https://www.nuget.org/packages/Grpc.AspNetCore/). This
option is enabled by default.
([#1423](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1423))
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropapagor to
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropagator to
CompositeTextMapPropagator. IPropagator is renamed to TextMapPropagator and
changed from interface to abstract class.
([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))

4
src/OpenTelemetry.Instrumentation.AspNetCore/Implementation/HttpInListener.cs
View File

@ -263,8 +263,8 @@ namespace OpenTelemetry.Instrumentation.AspNetCore.Implementation
}
// TODO: Should we get values from RouteData?
// private readonly PropertyFetcher beforActionRouteDataFetcher = new PropertyFetcher("routeData");
// var routeData = this.beforActionRouteDataFetcher.Fetch(payload) as RouteData;
// private readonly PropertyFetcher beforeActionRouteDataFetcher = new PropertyFetcher("routeData");
// var routeData = this.beforeActionRouteDataFetcher.Fetch(payload) as RouteData;
}
}
}

2
src/OpenTelemetry.Instrumentation.SqlClient/README.md
View File

@ -111,7 +111,7 @@ property should be used to control whether this instrumentation should set the
attribute to the text of the `SqlCommand` being executed. This could either be
a name of a stored procedure or a full text of a `CommandType.Text` query.
On .NET Framwork, unlike .NET Core, the instrumentation capabilities for both
On .NET Framework, unlike .NET Core, the instrumentation capabilities for both
[`Microsoft.Data.SqlClient`](https://www.nuget.org/packages/Microsoft.Data.SqlClient/)
and `System.Data.SqlClient` are limited:

2
src/OpenTelemetry.Shims.OpenTracing/CHANGELOG.md
View File

@ -53,7 +53,7 @@ Released 2020-Nov-17
Released 2020-Nov-5
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropapagor
* Renamed TextMapPropagator to TraceContextPropagator, CompositePropagator
to CompositeTextMapPropagator. IPropagator is renamed to TextMapPropagator
and changed from interface to abstract class.
([#1427](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1427))

10
src/OpenTelemetry/CHANGELOG.md
View File

@ -22,7 +22,7 @@ Released 2022-Mar-30
([#3038](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3038))
* Removed `MetricReaderType`. This enumeration was previously used when
configuing a metric reader with an exporter to configure whether the export
configuring a metric reader with an exporter to configure whether the export
cycle would be periodic or manual (i.e., requiring a explicit call to flush
metrics). This change affects the push-based metric exporters: OTLP, Console,
and InMemory. For these exporters, a manual export cycle can now be achieved
@ -165,7 +165,7 @@ Released 2021-Oct-08
* Exception from Observable instrument callbacks does not result in entire
metrics being lost.
* SDK is allocation-free on recording of measurements with upto 8 tags.
* SDK is allocation-free on recording of measurements with up to 8 tags.
* TracerProviderBuilder.AddLegacySource now supports wildcard activity names.
([#2183](https://github.com/open-telemetry/opentelemetry-dotnet/issues/2183))
@ -196,7 +196,7 @@ Released 2021-Sep-13
* Add `BatchExportActivityProcessorOptions` which supports field value
overriding using `OTEL_BSP_SCHEDULE_DELAY`, `OTEL_BSP_EXPORT_TIMEOUT`,
`OTEL_BSP_MAX_QUEUE_SIZE`, `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` envionmental
`OTEL_BSP_MAX_QUEUE_SIZE`, `OTEL_BSP_MAX_EXPORT_BATCH_SIZE` environmental
variables as defined in the
[specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.5.0/specification/sdk-environment-variables.md#batch-span-processor).
([#2219](https://github.com/open-telemetry/opentelemetry-dotnet/pull/2219))
@ -364,7 +364,7 @@ Released 2021-Jan-29
for Activity.Recorded in SimpleActivityExportProcessor and
BatchActivityExportProcessor
([#1622](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1622))
* Added check in `ActivitySourceAdapter` class for root activity if traceid is
* Added check in `ActivitySourceAdapter` class for root activity if trace ID is
overridden by calling `SetParentId`
([#1355](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1355))
* Resource Attributes now accept int, short, and float as values, converting
@ -378,7 +378,7 @@ Released 2021-Jan-29
* `BatchExportProcessor` will now flush any remaining spans left in a `Batch`
after the export operation has completed.
([#1726](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1726))
* Fixed a bug to allow the Self Diagnostics log file to be opened simutaneously
* Fixed a bug to allow the Self Diagnostics log file to be opened simultaneously
by another process in read-only mode for .NET Framework.
([#1693](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1693))
* Metrics removed as it is not part 1.0.0 release. See issue

4
test/OpenTelemetry.Exporter.Jaeger.Tests/JaegerExporterOptionsTests.cs
View File

@ -48,14 +48,14 @@ namespace OpenTelemetry.Exporter.Jaeger.Tests
[Fact]
public void JaegerExporterOptions_EnvironmentVariableOverride()
{
Environment.SetEnvironmentVariable(JaegerExporterOptions.OTelAgentHostEnvVarKey, "jeager-host");
Environment.SetEnvironmentVariable(JaegerExporterOptions.OTelAgentHostEnvVarKey, "jaeger-host");
Environment.SetEnvironmentVariable(JaegerExporterOptions.OTelAgentPortEnvVarKey, "123");
Environment.SetEnvironmentVariable(JaegerExporterOptions.OTelProtocolEnvVarKey, "http/thrift.binary");
Environment.SetEnvironmentVariable(JaegerExporterOptions.OTelEndpointEnvVarKey, "http://custom-endpoint:12345");
var options = new JaegerExporterOptions();
Assert.Equal("jeager-host", options.AgentHost);
Assert.Equal("jaeger-host", options.AgentHost);
Assert.Equal(123, options.AgentPort);
Assert.Equal(JaegerExportProtocol.HttpBinaryThrift, options.Protocol);
Assert.Equal(new Uri("http://custom-endpoint:12345"), options.Endpoint);

12
test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpMetricsExporterTests.cs
View File

@ -166,16 +166,16 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
Assert.Single(request.ResourceMetrics);
var resourceMetric = request.ResourceMetrics.First();
var oltpResource = resourceMetric.Resource;
var otlpResource = resourceMetric.Resource;
if (includeServiceNameInResource)
{
Assert.Contains(oltpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.StringValue == "service-name");
Assert.Contains(oltpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceNamespace && kvp.Value.StringValue == "ns1");
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.StringValue == "service-name");
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceNamespace && kvp.Value.StringValue == "ns1");
}
else
{
Assert.Contains(oltpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.ToString().Contains("unknown_service:"));
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.ToString().Contains("unknown_service:"));
}
Assert.Single(resourceMetric.InstrumentationLibraryMetrics);
@ -265,7 +265,7 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
[InlineData("test_counter", null, null, 123, null, AggregationTemporality.Delta, true)]
[InlineData("test_counter", "description", "unit", 123, null, AggregationTemporality.Cumulative, true)]
[InlineData("test_counter", null, null, 123, null, AggregationTemporality.Delta, true, "key1", "value1", "key2", 123)]
public void TestCounterToOltpMetric(string name, string description, string unit, long? longValue, double? doubleValue, AggregationTemporality aggregationTemporality, bool isMonotonic, params object[] keysValues)
public void TestCounterToOtlpMetric(string name, string description, string unit, long? longValue, double? doubleValue, AggregationTemporality aggregationTemporality, bool isMonotonic, params object[] keysValues)
{
var metrics = new List<Metric>();
@ -361,7 +361,7 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
[InlineData("test_histogram", null, null, 123, null, AggregationTemporality.Delta)]
[InlineData("test_histogram", "description", "unit", 123, null, AggregationTemporality.Cumulative)]
[InlineData("test_histogram", null, null, 123, null, AggregationTemporality.Delta, "key1", "value1", "key2", 123)]
public void TestHistogramToOltpMetric(string name, string description, string unit, long? longValue, double? doubleValue, AggregationTemporality aggregationTemporality, params object[] keysValues)
public void TestHistogramToOtlpMetric(string name, string description, string unit, long? longValue, double? doubleValue, AggregationTemporality aggregationTemporality, params object[] keysValues)
{
var metrics = new List<Metric>();

12
test/OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests/OtlpTraceExporterTests.cs
View File

@ -179,15 +179,15 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
request.AddBatch(resourceBuilder.Build().ToOtlpResource(), batch);
Assert.Single(request.ResourceSpans);
var oltpResource = request.ResourceSpans.First().Resource;
var otlpResource = request.ResourceSpans.First().Resource;
if (includeServiceNameInResource)
{
Assert.Contains(oltpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.StringValue == "service-name");
Assert.Contains(oltpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceNamespace && kvp.Value.StringValue == "ns1");
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.StringValue == "service-name");
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceNamespace && kvp.Value.StringValue == "ns1");
}
else
{
Assert.Contains(oltpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.ToString().Contains("unknown_service:"));
Assert.Contains(otlpResource.Attributes, (kvp) => kvp.Key == ResourceSemanticConventions.AttributeServiceName && kvp.Value.ToString().Contains("unknown_service:"));
}
foreach (var instrumentationLibrarySpans in request.ResourceSpans.First().InstrumentationLibrarySpans)
@ -349,8 +349,8 @@ namespace OpenTelemetry.Exporter.OpenTelemetryProtocol.Tests
}
[Theory]
[InlineData(ActivityStatusCode.Unset, "Description will be ingored if status is Unset.")]
[InlineData(ActivityStatusCode.Ok, "Description will be ingored if status is Okay.")]
[InlineData(ActivityStatusCode.Unset, "Description will be ignored if status is Unset.")]
[InlineData(ActivityStatusCode.Ok, "Description will be ignored if status is Okay.")]
[InlineData(ActivityStatusCode.Error, "Description will be kept if status is Error.")]
public void ToOtlpSpanNativeActivityStatusTest(ActivityStatusCode expectedStatusCode, string statusDescription)
{

2
test/OpenTelemetry.Exporter.Zipkin.Tests/ZipkinExporterTests.cs
View File

@ -92,7 +92,7 @@ namespace OpenTelemetry.Exporter.Zipkin.Tests
}
[Fact]
public void SuppresssesInstrumentation()
public void SuppressesInstrumentation()
{
const string ActivitySourceName = "zipkin.test";
Guid requestId = Guid.NewGuid();