Files
scadaproj/ZB.MOM.WW.Telemetry/tests/ZB.MOM.WW.Telemetry.Tests/ZbResourceTests.cs
T
Joseph Doherty cfc7168ace feat(telemetry): 0.3.0 service.version default, ResourceAttributes, logs follow AddZbTelemetry OTLP (#55)
- service.version: null ServiceVersion now defaults to the entry assembly's
  AssemblyInformationalVersion (the family apps stamp the git SHA there); "" omits it.
- ResourceAttributes: extra Resource attributes on every signal; first-class keys
  (service.*, host.name, site.id, node.role) are reserved and rejected at startup.
- Logs over OTLP: AddZbTelemetry publishes its options in DI and AddZbSerilog's OTLP
  log sink follows them when its own options do not select Otlp, so
  <App>:Telemetry:Exporter=Otlp now switches logs along with metrics and traces, with
  the same endpoint and Resource. ExportLogs=false opts out.
- Ships the unpublished 0.2.1 review fixes, including the stricter OTLP endpoint check
  (scheme-less host:port rejected when Exporter=Otlp); no app config sets an endpoint.
- Tests 42 -> 74, incl. a loopback OTLP/gRPC receiver proving logs arrive with the
  Resource, and an ExportLogs=false case with a metrics positive control.

Claude-Session: https://claude.ai/code/session_01GT67ACmpMR7b9LGRPLijMi
2026-11-12 21:28:50 -05:00

76 lines
2.8 KiB
C#

using OpenTelemetry.Resources;
using ZB.MOM.WW.Telemetry;
namespace ZB.MOM.WW.Telemetry.Tests;
public sealed class ZbResourceTests
{
[Fact]
public void Build_PopulatesAllResourceAttributes()
{
var options = new ZbTelemetryOptions
{
ServiceName = "otopcua",
ServiceNamespace = "ZB.MOM.WW",
ServiceVersion = "1.2.3",
SiteId = "site-7",
NodeRole = "central",
};
var resource = ZbResource.Build(options).Build();
var attributes = resource.Attributes.ToDictionary(a => a.Key, a => a.Value);
Assert.Equal("otopcua", attributes["service.name"]);
Assert.Equal("ZB.MOM.WW", attributes["service.namespace"]);
Assert.Equal("1.2.3", attributes["service.version"]);
Assert.Equal("site-7", attributes["site.id"]);
Assert.Equal("central", attributes["node.role"]);
Assert.Equal(Environment.MachineName, attributes["host.name"]);
// service.instance.id must be the deterministic MachineName:ProcessId — NOT a random GUID.
Assert.Equal(ZbResource.InstanceId, attributes["service.instance.id"]);
}
[Fact]
public void Build_OmitsOptionalAttributes_WhenNull()
{
var options = new ZbTelemetryOptions
{
ServiceName = "mxgateway",
// "" = omit service.version (null now means the entry-assembly default, scadaproj#55);
// SiteId / NodeRole left null.
ServiceVersion = "",
};
var resource = ZbResource.Build(options).Build();
var keys = resource.Attributes.Select(a => a.Key).ToHashSet();
Assert.Contains("service.name", keys);
Assert.Contains("service.namespace", keys);
Assert.Contains("host.name", keys);
// service.instance.id is always present (deterministic, not optional).
Assert.Contains("service.instance.id", keys);
Assert.DoesNotContain("service.version", keys);
Assert.DoesNotContain("site.id", keys);
Assert.DoesNotContain("node.role", keys);
}
[Fact]
public void InstanceId_is_deterministic_MachineName_colon_ProcessId()
{
// InstanceId must be stable within the process and follow the MachineName:ProcessId format.
var expected = $"{Environment.MachineName}:{Environment.ProcessId}";
Assert.Equal(expected, ZbResource.InstanceId);
// Calling it twice returns the same value (no random component).
Assert.Equal(ZbResource.InstanceId, ZbResource.InstanceId);
}
[Fact]
public void InstanceId_does_not_contain_a_random_guid()
{
// The old OTel SDK default was a random GUID; the deterministic id must NOT be a GUID.
Assert.False(
Guid.TryParse(ZbResource.InstanceId, out _),
$"service.instance.id must not be a GUID; got '{ZbResource.InstanceId}'");
}
}