Drop the usage of name field (open-telemetry#2565)

srikanthccv · lzchen · web-flow · commit 64a25a0addcc · 2022-03-25T14:12:27.000-06:00
* Drop the usage of name field

* Add CHANGELOG entry

* Update CHANGELOG.md

Co-authored-by: Leighton Chen &lt;lechen@microsoft.com&gt;

Co-authored-by: Leighton Chen &lt;lechen@microsoft.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#2533](https://github.com/open-telemetry/opentelemetry-python/pull/2533))
 - Add InMemoryMetricReader to metrics SDK
   ([#2540](https://github.com/open-telemetry/opentelemetry-python/pull/2540))
+- Drop the usage of name field from log model in OTLP
+  ([#2565](https://github.com/open-telemetry/opentelemetry-python/pull/2565))
 
 ## [1.10.0-0.29b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.10.0-0.29b0) - 2022-03-10
 
diff --git a/exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_log_exporter/__init__.py b/exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/_log_exporter/__init__.py
@@ -63,9 +63,6 @@ def __init__(
             }
         )
 
-    def _translate_name(self, log_data: LogData) -> None:
-        self._collector_kwargs["name"] = log_data.log_record.name
-
     def _translate_time(self, log_data: LogData) -> None:
         self._collector_kwargs[
             "time_unix_nano"
@@ -140,7 +137,6 @@ def _translate_data(
 
             self._collector_kwargs = {}
 
-            self._translate_name(log_data)
             self._translate_time(log_data)
             self._translate_span_id(log_data)
             self._translate_trace_id(log_data)
diff --git a/exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py b/exporter/opentelemetry-exporter-otlp-proto-grpc/tests/logs/test_otlp_logs_exporter.py
@@ -119,7 +119,6 @@ def setUp(self):
                 trace_flags=TraceFlags(0x01),
                 severity_text="WARNING",
                 severity_number=SDKSeverityNumber.WARN,
-                name="name",
                 body="Zhengzhou, We have a heaviest rains in 1000 years",
                 resource=SDKResource({"key": "value"}),
                 attributes={"a": 1, "b": "c"},
@@ -136,7 +135,6 @@ def setUp(self):
                 trace_flags=TraceFlags(0x01),
                 severity_text="INFO",
                 severity_number=SDKSeverityNumber.INFO2,
-                name="info name",
                 body="Sydney, Opera House is closed",
                 resource=SDKResource({"key": "value"}),
                 attributes={"custom_attr": [1, 2, 3]},
@@ -153,7 +151,6 @@ def setUp(self):
                 trace_flags=TraceFlags(0x01),
                 severity_text="ERROR",
                 severity_number=SDKSeverityNumber.WARN,
-                name="error name",
                 body="Mumbai, Boil water before drinking",
                 resource=SDKResource({"service": "myapp"}),
             ),
@@ -315,7 +312,6 @@ def test_translate_log_data(self):
                             log_records=[
                                 PB2LogRecord(
                                     # pylint: disable=no-member
-                                    name="name",
                                     time_unix_nano=self.log_data_1.log_record.timestamp,
                                     severity_number=self.log_data_1.log_record.severity_number.value,
                                     severity_text="WARNING",
@@ -375,7 +371,6 @@ def test_translate_multiple_logs(self):
                             log_records=[
                                 PB2LogRecord(
                                     # pylint: disable=no-member
-                                    name="name",
                                     time_unix_nano=self.log_data_1.log_record.timestamp,
                                     severity_number=self.log_data_1.log_record.severity_number.value,
                                     severity_text="WARNING",
@@ -413,7 +408,6 @@ def test_translate_multiple_logs(self):
                             log_records=[
                                 PB2LogRecord(
                                     # pylint: disable=no-member
-                                    name="info name",
                                     time_unix_nano=self.log_data_2.log_record.timestamp,
                                     severity_number=self.log_data_2.log_record.severity_number.value,
                                     severity_text="INFO",
@@ -459,7 +453,6 @@ def test_translate_multiple_logs(self):
                             log_records=[
                                 PB2LogRecord(
                                     # pylint: disable=no-member
-                                    name="error name",
                                     time_unix_nano=self.log_data_3.log_record.timestamp,
                                     severity_number=self.log_data_3.log_record.severity_number.value,
                                     severity_text="ERROR",
diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/_logs/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/_logs/__init__.py
@@ -59,7 +59,6 @@ def __init__(
         trace_flags: Optional[TraceFlags] = None,
         severity_text: Optional[str] = None,
         severity_number: Optional[SeverityNumber] = None,
-        name: Optional[str] = None,
         body: Optional[Any] = None,
         resource: Optional[Resource] = None,
         attributes: Optional[Attributes] = None,
@@ -70,7 +69,6 @@ def __init__(
         self.trace_flags = trace_flags
         self.severity_text = severity_text
         self.severity_number = severity_number
-        self.name = name
         self.body = body
         self.resource = resource
         self.attributes = attributes
@@ -84,7 +82,6 @@ def to_json(self) -> str:
         return json.dumps(
             {
                 "body": self.body,
-                "name": self.name,
                 "severity_number": repr(self.severity_number),
                 "severity_text": self.severity_text,
                 "attributes": self.attributes,
diff --git a/opentelemetry-sdk/tests/logs/test_export.py b/opentelemetry-sdk/tests/logs/test_export.py
@@ -334,7 +334,6 @@ def test_export(self):  # pylint: disable=no-self-use
                 trace_flags=TraceFlags(0x01),
                 severity_text="WARN",
                 severity_number=SeverityNumber.WARN,
-                name="name",
                 body="Zhengzhou, We have a heaviest rains in 1000 years",
                 resource=SDKResource({"key": "value"}),
                 attributes={"a": 1, "b": "c"},
diff --git a/opentelemetry-sdk/tests/logs/test_log_record.py b/opentelemetry-sdk/tests/logs/test_log_record.py
@@ -23,7 +23,6 @@ def test_log_record_to_json(self):
         expected = json.dumps(
             {
                 "body": "a log line",
-                "name": None,
                 "severity_number": "None",
                 "severity_text": None,
                 "attributes": None,

Original file line number	Diff line number	Diff line change
`@@ -63,9 +63,6 @@ def __init__(`
`63`	`63`	`}`
`64`	`64`	`)`
`65`	`65`
`66`		`- def _translate_name(self, log_data: LogData) -> None:`
`67`		`- self._collector_kwargs["name"] = log_data.log_record.name`
`68`		`-`
`69`	`66`	`def _translate_time(self, log_data: LogData) -> None:`
`70`	`67`	`self._collector_kwargs[`
`71`	`68`	`"time_unix_nano"`
`@@ -140,7 +137,6 @@ def _translate_data(`
`140`	`137`
`141`	`138`	`self._collector_kwargs = {}`
`142`	`139`
`143`		`- self._translate_name(log_data)`
`144`	`140`	`self._translate_time(log_data)`
`145`	`141`	`self._translate_span_id(log_data)`
`146`	`142`	`self._translate_trace_id(log_data)`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ def test_log_record_to_json(self):`
`23`	`23`	`expected = json.dumps(`
`24`	`24`	`{`
`25`	`25`	`"body": "a log line",`
`26`		`- "name": None,`
`27`	`26`	`"severity_number": "None",`
`28`	`27`	`"severity_text": None,`
`29`	`28`	`"attributes": None,`