From d809c6e81e6526f57523e614d361de35c975462f Mon Sep 17 00:00:00 2001
From: "Edgar R. M" <edgar@meltano.com>
Date: Mon, 3 Apr 2023 07:16:14 -0600
Subject: [PATCH] fix: Conform metric field `type` to Singer spec (#1574)

According to the [Singer
Spec](https://github.com/singer-io/getting-started/blob/master/docs/SYNC_MODE.md#metric-messages),
the correct field name is `type` and not `metric_type`.
---
 docs/implementation/logging.md |  2 +-
 singer_sdk/metrics.py          | 14 +++++++++++---
 tests/core/test_metrics.py     |  4 ++--
 3 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/docs/implementation/logging.md b/docs/implementation/logging.md
index ea9e186b9..da20a5780 100644
--- a/docs/implementation/logging.md
+++ b/docs/implementation/logging.md
@@ -51,7 +51,7 @@ version: 1
 disable_existing_loggers: false
 formatters:
   metrics:
-    format: "{asctime} {message}"
+    format: "{asctime} {levelname} {message}"
     style: "{"
 handlers:
   metrics:
diff --git a/singer_sdk/metrics.py b/singer_sdk/metrics.py
index 1c69a3681..f61d3e1ee 100644
--- a/singer_sdk/metrics.py
+++ b/singer_sdk/metrics.py
@@ -8,7 +8,7 @@
 import logging
 import logging.config
 import os
-from dataclasses import asdict, dataclass, field
+from dataclasses import dataclass, field
 from pathlib import Path
 from time import time
 from typing import TYPE_CHECKING, Any, Generic, Mapping, TypeVar
@@ -79,7 +79,15 @@ def to_json(self) -> str:
         Returns:
             A JSON object.
         """
-        return json.dumps(asdict(self), default=str)
+        return json.dumps(
+            {
+                "type": self.metric_type,
+                "metric": self.metric.value,
+                "value": self.value,
+                "tags": self.tags,
+            },
+            default=str,
+        )
 
 
 def log(logger: logging.Logger, point: Point) -> None:
@@ -89,7 +97,7 @@ def log(logger: logging.Logger, point: Point) -> None:
         logger: An logger instance.
         point: A measurement.
     """
-    logger.info("INFO METRIC: %s", point)
+    logger.info("METRIC: %s", point)
 
 
 class Meter(metaclass=abc.ABCMeta):
diff --git a/tests/core/test_metrics.py b/tests/core/test_metrics.py
index 5eb8fa501..a9d6b4d26 100644
--- a/tests/core/test_metrics.py
+++ b/tests/core/test_metrics.py
@@ -59,7 +59,7 @@ def test_record_counter(caplog: pytest.LogCaptureFixture):
 
     for record in caplog.records:
         assert record.levelname == "INFO"
-        assert record.msg == "INFO METRIC: %s"
+        assert record.msg == "METRIC: %s"
         assert "test=1" in record.message
 
         point: metrics.Point[int] = record.args[0]
@@ -89,7 +89,7 @@ def test_sync_timer(caplog: pytest.LogCaptureFixture):
 
     record = caplog.records[0]
     assert record.levelname == "INFO"
-    assert record.msg == "INFO METRIC: %s"
+    assert record.msg == "METRIC: %s"
 
     point: metrics.Point[float] = record.args[0]
     assert point.metric_type == "timer"