Skip to content

Commit

Permalink
update naming (non-docs files)
Browse files Browse the repository at this point in the history
  • Loading branch information
colleenmcginnis committed Aug 15, 2024
1 parent 1de0ef3 commit d023eff
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion src/Elastic.OpenTelemetry/AutoInstrumentationPlugin.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
namespace Elastic.OpenTelemetry;

/// <summary>
/// Elastic Distribution for OpenTelemetry .NET plugin for Auto Instrumentation.
/// Elastic Distribution of OpenTelemetry .NET plugin for Auto Instrumentation.
/// <para>Ensures all signals are rich enough to report to Elastic</para>
/// </summary>
// ReSharper disable once UnusedType.Global
Expand Down
8 changes: 4 additions & 4 deletions src/Elastic.OpenTelemetry/Configuration/ElasticDefaults.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ public enum ElasticDefaults
/// <summary> No Elastic defaults will be included, acting effectively as a vanilla OpenTelemetry </summary>
None,

/// <summary> Include Elastic Distribution for OpenTelemetry .NET tracing defaults</summary>
/// <summary> Include Elastic Distribution of OpenTelemetry .NET tracing defaults</summary>
Traces = 1 << 0, //1

/// <summary> Include Elastic Distribution for OpenTelemetry .NET metrics defaults</summary>
/// <summary> Include Elastic Distribution of OpenTelemetry .NET metrics defaults</summary>
Metrics = 1 << 1, //2

/// <summary> Include Elastic Distribution for OpenTelemetry .NET logging defaults</summary>
/// <summary> Include Elastic Distribution of OpenTelemetry .NET logging defaults</summary>
Logs = 1 << 2, //4

/// <summary> (default) Include all Elastic Distribution for OpenTelemetry .NET logging defaults</summary>
/// <summary> (default) Include all Elastic Distribution of OpenTelemetry .NET logging defaults</summary>
All = ~0
}
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ private static string GetDefaultLogDirectory()
public string LogDirectoryDefault { get; }

/// <summary>
/// The output directory where the Elastic Distribution for OpenTelemetry .NET will write log files.
/// The output directory where the Elastic Distribution of OpenTelemetry .NET will write log files.
/// </summary>
/// <remarks>
/// When configured, a file log will be created in this directory with the name
Expand Down Expand Up @@ -192,7 +192,7 @@ public bool SkipOtlpExporter
}

/// <summary>
/// Allows flags to be set based of <see cref="Configuration.ElasticDefaults"/> to selectively opt in to Elastic Distribution for OpenTelemetry .NET features.
/// Allows flags to be set based of <see cref="Configuration.ElasticDefaults"/> to selectively opt in to Elastic Distribution of OpenTelemetry .NET features.
/// <para>Defaults to <see cref="ElasticDefaults.All"/></para>
/// </summary>
/// <remarks>
Expand All @@ -212,7 +212,7 @@ public ElasticDefaults ElasticDefaults
}

/// <summary>
/// Control which signals will be automatically enabled by the Elastic Distribution for OpenTelemetry .NET.
/// Control which signals will be automatically enabled by the Elastic Distribution of OpenTelemetry .NET.
/// <para>
/// This configuration respects the open telemetry environment configuration out of the box:
/// <list type="bullet">
Expand Down
8 changes: 4 additions & 4 deletions src/Elastic.OpenTelemetry/Configuration/Signals.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ public enum Signals
/// <summary> No Elastic defaults will be included, acting effectively as a vanilla OpenTelemetry </summary>
None,

/// <summary> Include Elastic Distribution for OpenTelemetry .NET tracing defaults</summary>
/// <summary> Include Elastic Distribution of OpenTelemetry .NET tracing defaults</summary>
Traces = 1 << 0, //1

/// <summary> Include Elastic Distribution for OpenTelemetry .NET metrics defaults</summary>
/// <summary> Include Elastic Distribution of OpenTelemetry .NET metrics defaults</summary>
Metrics = 1 << 1, //2

/// <summary> Include Elastic Distribution for OpenTelemetry .NET logging defaults</summary>
/// <summary> Include Elastic Distribution of OpenTelemetry .NET logging defaults</summary>
Logs = 1 << 2, //4

/// <summary> (default) Include all Elastic Distribution for OpenTelemetry .NET logging defaults</summary>
/// <summary> (default) Include all Elastic Distribution of OpenTelemetry .NET logging defaults</summary>
All = ~0
}
6 changes: 3 additions & 3 deletions src/Elastic.OpenTelemetry/Diagnostics/LoggerMessages.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ internal static partial class LoggerMessages
public static void LogAgentPreamble(this ILogger logger)
{
var process = Process.GetCurrentProcess();
logger.LogInformation("Elastic Distribution for OpenTelemetry .NET: {AgentInformationalVersion}", VersionHelper.InformationalVersion);
logger.LogInformation("Elastic Distribution of OpenTelemetry .NET: {AgentInformationalVersion}", VersionHelper.InformationalVersion);
if (logger is CompositeLogger distributionLogger)
{
if (distributionLogger.LogFileEnabled)
logger.LogInformation("Elastic Distribution for OpenTelemetry .NET, log file: {LogFilePath}", distributionLogger.LogFilePath);
logger.LogInformation("Elastic Distribution of OpenTelemetry .NET, log file: {LogFilePath}", distributionLogger.LogFilePath);
else
logger.LogInformation("Elastic Distribution for OpenTelemetry .NET, log file: <disabled>");
logger.LogInformation("Elastic Distribution of OpenTelemetry .NET, log file: <disabled>");
}

logger.LogInformation("Process ID: {ProcessId}", process.Id);
Expand Down
2 changes: 1 addition & 1 deletion src/Elastic.OpenTelemetry/Elastic.OpenTelemetry.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<OutputType>Library</OutputType>
<TargetFrameworks>netstandard2.0;netstandard2.1;net462;net6.0;net8.0</TargetFrameworks>
<Title>Elastic Distribution for OpenTelemetry .NET</Title>
<Title>Elastic Distribution of OpenTelemetry .NET</Title>
<Description>OpenTelemetry extensions for Elastic Observability, fully native with zero code changes.</Description>
<PackageTags>elastic;opentelemetry;observabillity;apm;logs;metrics;traces;monitoring</PackageTags>
<ImplicitUsings>enable</ImplicitUsings>
Expand Down
2 changes: 1 addition & 1 deletion src/Elastic.OpenTelemetry/ElasticOpenTelemetryBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public class ElasticOpenTelemetryBuilder : IOpenTelemetryBuilder
public IServiceCollection Services { get; }

/// <summary>
/// Shared bootstrap routine for the Elastic Distribution for OpenTelemetry .NET.
/// Shared bootstrap routine for the Elastic Distribution of OpenTelemetry .NET.
/// Used to ensure auto instrumentation and manual instrumentation bootstrap the same way.
/// </summary>
public static (EventListener, ILogger) Bootstrap(ElasticOpenTelemetryBuilderOptions options)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ namespace Elastic.OpenTelemetry.Extensions;
/// </summary>
public static class MeterProviderBuilderExtensions
{
/// <summary> Use Elastic Distribution for OpenTelemetry .NET defaults for <see cref="MeterProviderBuilder"/> </summary>
/// <summary> Use Elastic Distribution of OpenTelemetry .NET defaults for <see cref="MeterProviderBuilder"/> </summary>
public static MeterProviderBuilder UseElasticDefaults(this MeterProviderBuilder builder, ILogger? logger = null)
{
logger ??= NullLogger.Instance;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ private static TracerProviderBuilder LogAndAddProcessor(this TracerProviderBuild
return builder.AddProcessor(processor);
}

/// <summary> Use Elastic Distribution for OpenTelemetry .NET defaults for <see cref="TracerProviderBuilder"/> </summary>
/// <summary> Use Elastic Distribution of OpenTelemetry .NET defaults for <see cref="TracerProviderBuilder"/> </summary>
public static TracerProviderBuilder UseElasticDefaults(this TracerProviderBuilder builder, ILogger? logger = null)
{
logger ??= NullLogger.Instance;
Expand Down
2 changes: 1 addition & 1 deletion src/Elastic.OpenTelemetry/IInstrumentationLifetime.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
namespace Elastic.OpenTelemetry;

/// <summary>
/// A logical Elastic Distribution for OpenTelemetry .NET instance.
/// A logical Elastic Distribution of OpenTelemetry .NET instance.
/// </summary>
public interface IInstrumentationLifetime : IDisposable, IAsyncDisposable;
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public async Task ObserveDistributionPluginLoad()
var output = exampleApplicationContainer.FailureTestOutput();
output.Should()
.NotBeNullOrWhiteSpace()
.And.Contain("Elastic Distribution for OpenTelemetry .NET:")
.And.Contain("Elastic Distribution of OpenTelemetry .NET:")
.And.Contain("ElasticOpenTelemetryBuilder initialized")
.And.Contain("Added 'Elastic.OpenTelemetry.Processors.ElasticCompatibilityProcessor'");

Expand Down
4 changes: 2 additions & 2 deletions tests/Elastic.OpenTelemetry.Tests/LoggingTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ public async Task ObserveLogging()
}

//assert preamble information gets logged
logger.Messages.Should().ContainMatch("*Elastic Distribution for OpenTelemetry .NET:*");
logger.Messages.Should().ContainMatch("*Elastic Distribution of OpenTelemetry .NET:*");

var preambles = logger.Messages.Where(l => l.Contains("[Information] Elastic Distribution for OpenTelemetry .NET:")).ToList();
var preambles = logger.Messages.Where(l => l.Contains("[Information] Elastic Distribution of OpenTelemetry .NET:")).ToList();
preambles.Should().NotBeNull().And.HaveCount(1);

// assert instrumentation session logs initialized and stack trace gets dumped.
Expand Down

0 comments on commit d023eff

Please sign in to comment.