Skip to content

[sdk] Generate a consistent instanceId for the lifetime of a process #4988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 25, 2023
Merged

[sdk] Generate a consistent instanceId for the lifetime of a process #4988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8401642
Generate a consistent instanceId for the lifetime of a process.
CodeBlanch Oct 25, 2023
58ffc0b
Merge branch 'main' into resource-instance-id
CodeBlanch Oct 25, 2023
cf4e6a0
CHANGELOG patch.
CodeBlanch Oct 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/OpenTelemetry/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
`8.0.0-rc.2.23479.6`.
([#4959](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4959))

* The `AddService` `ResourceBuilder` extension method will now generate the same
`service.instance.id` for the lifetime of a process when
`autoGenerateServiceInstanceId` is `true`.
([#4988](https://github.com/open-telemetry/opentelemetry-dotnet/pull/4988))

## 1.7.0-alpha.1

Released 2023-Oct-16
Expand Down
4 changes: 3 additions & 1 deletion src/OpenTelemetry/Resources/ResourceBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ namespace OpenTelemetry.Resources;
/// </summary>
public static class ResourceBuilderExtensions
{
private static readonly string InstanceId = Guid.NewGuid().ToString();

private static Resource TelemetryResource { get; } = new Resource(new Dictionary<string, object>
{
[ResourceSemanticConventions.AttributeTelemetrySdkName] = "opentelemetry",
Expand Down Expand Up @@ -71,7 +73,7 @@ public static ResourceBuilder AddService(

if (serviceInstanceId == null && autoGenerateServiceInstanceId)
{
serviceInstanceId = Guid.NewGuid().ToString();
serviceInstanceId = InstanceId;
}

if (serviceInstanceId != null)
Expand Down
18 changes: 18 additions & 0 deletions test/OpenTelemetry.Tests/Resources/ResourceBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,24 @@ public void ServiceResource_AutoGenerateServiceInstanceIdOff()
Assert.Contains(new KeyValuePair<string, object>(ResourceSemanticConventions.AttributeServiceName, "my-service"), resource.Attributes);
}

[Fact]
public void ServiceResourceGeneratesConsistentInstanceId()
{
var firstResource = ResourceBuilder.CreateEmpty().AddService("my-service").Build();

var firstInstanceIdAttribute = firstResource.Attributes.FirstOrDefault(kvp => kvp.Key == ResourceSemanticConventions.AttributeServiceInstance);

Assert.NotNull(firstInstanceIdAttribute.Value);

var secondResource = ResourceBuilder.CreateEmpty().AddService("other-service").Build();

var secondInstanceIdAttribute = secondResource.Attributes.FirstOrDefault(kvp => kvp.Key == ResourceSemanticConventions.AttributeServiceInstance);

Assert.NotNull(secondInstanceIdAttribute.Value);

Assert.Equal(firstInstanceIdAttribute.Value, secondInstanceIdAttribute.Value);
}

[Fact]
public void ClearTest()
{
Expand Down