Skip to content

fix(sdk): correct instrument name validation error message length #5513

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

Open
theycallmeloki wants to merge 2 commits into
base: main
Choose a base branch
from
+25 −5
Open

fix(sdk): correct instrument name validation error message length #5513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9fb907
fix(sdk): correct instrument name validation error message length
theycallmeloki Aug 6, 2026
f1e2f84
Merge branch 'main' into fix/instrument-validation-message
theycallmeloki Aug 7, 2026
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
1 change: 1 addition & 0 deletions .changelog/5284.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix misleading instrument name validation error message (name max length is 255, not 63).
15 changes: 10 additions & 5 deletions opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/instrument.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,12 @@
_logger = getLogger(__name__)


_ERROR_MESSAGE = "Expected ASCII string of maximum length 63 characters but got {}"
_NAME_ERROR_MESSAGE = (
"Expected ASCII string of maximum length 255 characters but got {}"
)
_UNIT_ERROR_MESSAGE = (
"Expected ASCII string of maximum length 63 characters but got {}"
)


@runtime_checkable
Expand All @@ -73,11 +78,11 @@ def __init__(

if result["name"] is None:
# pylint: disable=broad-exception-raised
raise Exception(_ERROR_MESSAGE.format(name))
raise Exception(_NAME_ERROR_MESSAGE.format(name))

if result["unit"] is None:
# pylint: disable=broad-exception-raised
raise Exception(_ERROR_MESSAGE.format(unit))
raise Exception(_UNIT_ERROR_MESSAGE.format(unit))

name = result["name"]
unit = result["unit"]
Expand Down Expand Up @@ -112,11 +117,11 @@ def __init__(

if result["name"] is None:
# pylint: disable=broad-exception-raised
raise Exception(_ERROR_MESSAGE.format(name))
raise Exception(_NAME_ERROR_MESSAGE.format(name))

if result["unit"] is None:
# pylint: disable=broad-exception-raised
raise Exception(_ERROR_MESSAGE.format(unit))
raise Exception(_UNIT_ERROR_MESSAGE.format(unit))

name = result["name"]
unit = result["unit"]
Expand Down
14 changes: 14 additions & 0 deletions opentelemetry-sdk/tests/metrics/test_instrument.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,3 +559,17 @@ def test_disallow_direct_histogram_creation(self):
with self.assertRaises(TypeError):
# pylint: disable=abstract-class-instantiated
Histogram("name", Mock(), Mock())


class TestInstrumentValidationMessages(TestCase):
def test_invalid_name_error_message(self):
with self.assertRaises(Exception) as ctx:
_Counter("1-invalid-name", Mock(), Mock())
self.assertIn("maximum length 255", str(ctx.exception))
self.assertNotIn("63", str(ctx.exception))

def test_invalid_unit_error_message(self):
with self.assertRaises(Exception) as ctx:
_Counter("name", Mock(), Mock(), unit="u" * 64)
self.assertIn("maximum length 63", str(ctx.exception))
self.assertNotIn("255", str(ctx.exception))