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

Resource attributes fix (#1720) 

* Redoing changes from old PR1647

* Changelog

Co-authored-by: Cijo Thomas <cithomas@microsoft.com>
This commit is contained in:
Austin Tan 2021-01-26 14:28:11 -08:00 committed by GitHub
parent 17dd4a7d56
commit 842daff4d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 38 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/OpenTelemetry/CHANGELOG.md
View File

@ -22,6 +22,10 @@
* Added check in `ActivitySourceAdapter` class for root activity if traceid 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
them to supported data types (long for int/short, double for float). For
invalid attributes we now throw an exception instead of logging an error.
([#1720](https://github.com/open-telemetry/opentelemetry-dotnet/pull/1720))
## 1.0.0-rc1.1

35
src/OpenTelemetry/Resources/Resource.cs
View File

@ -101,28 +101,33 @@ namespace OpenTelemetry.Resources
sanitizedKey = attribute.Key;
}
object sanitizedValue;
if (!IsValidValue(attribute.Value))
{
OpenTelemetrySdkEventSource.Log.InvalidArgument("Create resource", "attribute value", "Attribute value should be a non-null string, long, bool or double.");
sanitizedValue = string.Empty;
}
else
{
sanitizedValue = attribute.Value;
}
object sanitizedValue = SanitizeValue(attribute.Value, sanitizedKey);
return new KeyValuePair<string, object>(sanitizedKey, sanitizedValue);
}
private static bool IsValidValue(object value)
private static object SanitizeValue(object value, string keyName)
{
if (value != null && (value is string || value is bool || value is long || value is double))
if (value != null)
{
return true;
if (value is string || value is bool || value is long || value is double)
{
return value;
}
if (value is int || value is short)
{
return System.Convert.ToInt64(value);
}
if (value is float)
{
return System.Convert.ToDouble(value, System.Globalization.CultureInfo.InvariantCulture);
}
throw new System.ArgumentException("Attribute value type is not an accepted primitive", keyName);
}
return false;
throw new System.ArgumentException("Attribute value is null", keyName);
}
}
}

32
test/OpenTelemetry.Tests/Resources/ResourceTest.cs
View File

@ -46,15 +46,8 @@ namespace OpenTelemetry.Resources.Tests
// Arrange
var attributes = new Dictionary<string, object> { { "NullValue", null } };
// Act
var resource = new Resource(attributes);
// Assert
Assert.Single(resource.Attributes);
var attribute = resource.Attributes.Single();
Assert.Equal("NullValue", attribute.Key);
Assert.Empty((string)attribute.Value);
// Act and Assert
Assert.Throws<ArgumentException>(() => new Resource(attributes));
}
[Fact]
@ -139,15 +132,25 @@ namespace OpenTelemetry.Resources.Tests
{ "long", 1L },
{ "bool", true },
{ "double", 0.1d },
// int and float supported by conversion to long and double
{ "int", 1 },
{ "short", (short)1 },
{ "float", 0.1f },
};
var resource = new Resource(attributes);
Assert.Equal(4, resource.Attributes.Count());
Assert.Equal(7, resource.Attributes.Count());
Assert.Contains(new KeyValuePair<string, object>("string", "stringValue"), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("long", 1L), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("bool", true), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("double", 0.1d), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("int", 1L), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("short", 1L), resource.Attributes);
double convertedFloat = Convert.ToDouble(0.1f, System.Globalization.CultureInfo.InvariantCulture);
Assert.Contains(new KeyValuePair<string, object>("float", convertedFloat), resource.Attributes);
}
[Fact]
@ -158,16 +161,9 @@ namespace OpenTelemetry.Resources.Tests
{ "dynamic", new { } },
{ "array", new int[1] },
{ "complex", this },
{ "float", 0.1f },
};
var resource = new Resource(attributes);
Assert.Equal(4, resource.Attributes.Count());
Assert.Contains(new KeyValuePair<string, object>("dynamic", string.Empty), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("array", string.Empty), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("complex", string.Empty), resource.Attributes);
Assert.Contains(new KeyValuePair<string, object>("float", string.Empty), resource.Attributes);
Assert.Throws<ArgumentException>(() => new Resource(attributes));
}
[Fact]