Fix incorrect default Jaeger service name in OpenTelemetry config

[SasinduDilshara]

Summary

• Changes the default value of opentelemetry.service.name in distribution/src/resources/config-tool/default.json from WSO2-SYNAPSE to wso2-synapse.
• The bundled Grafana dashboards filter traces using wso2-synapse (lowercase). Since Jaeger service names are case-sensitive, the old default (WSO2-SYNAPSE) caused the Grafana → Jaeger trace link to find no matching service, forcing users to manually retype the name.
• This one-character-case change makes the default service name consistent with the Grafana dashboard expectations out of the box.

Root Cause

TelemetryConstants.SERVICE_NAME is hard-coded as "WSO2-SYNAPSE". The config-tool default was also "WSO2-SYNAPSE", but the Grafana dashboard templates ship with wso2-synapse (lowercase) as the service-name filter. Jaeger is case-sensitive, so the mismatch breaks the Grafana → Jaeger navigation.

Test plan

• Start MI with default deployment.toml (no service_name override).
• Verify conf/synapse.properties contains opentelemetry.service.name = wso2-synapse.
• Enable OpenTelemetry (opentelemetry.enable = true) and confirm spans are published to Jaeger under the service name wso2-synapse.
• Open the bundled Grafana dashboard and click a trace link — confirm it navigates to the correct service in Jaeger without requiring a manual name change.

Fixes #4200

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

• Chores
  • Updated OpenTelemetry service name configuration to use lowercase format for improved consistency with naming conventions.

[coderabbitai]

Warning

Rate limit exceeded

@SasinduDilshara has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 3 minutes and 48 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 3 minutes and 48 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1cafa566-a0fc-4457-b9da-b93261d554ac

📥 Commits

Reviewing files that changed from the base of the PR and between 68a2642 and 0212dd2.

📒 Files selected for processing (1)

• distribution/src/resources/config-tool/key-mappings.json

Walkthrough

A configuration value in the default JSON settings has been updated to correct the OpenTelemetry service name from uppercase "WSO2-SYNAPSE" to lowercase "wso2-synapse" for alignment with Grafana dashboard naming conventions.

Changes

Cohort / File(s)	Summary
Configuration Update distribution/src/resources/config-tool/default.json	Changed synapse_properties.'opentelemetry.service.name' value from "WSO2-SYNAPSE" to "wso2-synapse" to match Grafana dashboard service name expectations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A case so small, yet mighty true,
From caps to lowercase, we renew!
Now Jaeger names and Grafana align,
With wso2-synapse in lowercase shine! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description provides a comprehensive summary, root cause analysis, and test plan, but omits most required template sections (purpose/goals/approach, user stories, release notes, documentation, training, certification, marketing, automation tests, security checks, samples, migrations, test environment, and learning).	Complete the PR description using the provided template structure: add Purpose, Goals, Approach, User Stories, Release Note, Documentation, Training, Certification, Marketing, Automation Tests, Security Checks, Samples, Related PRs, Migrations, Test Environment, and Learning sections.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main change: fixing the Jaeger service name case in the OpenTelemetry configuration, which directly addresses the primary objective of the pull request.
Linked Issues check	✅ Passed	The PR fully addresses the coding requirement from issue #4200: changing the Jaeger service name from 'WSO2-SYNAPSE' to 'wso2-synapse' to match the bundled Grafana dashboards and eliminate the case-sensitivity mismatch.
Out of Scope Changes check	✅ Passed	The change is narrowly scoped to the single configuration value required by issue #4200; no extraneous modifications to other files or unrelated functionality are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[SasinduDilshara]

Claude Issue Analysis — [Issue #4200]: Incorrect Jaeger service name in Grafana dashboards

Classification

• Type: Bug
• Severity Assessment: Medium
• Affected Component(s): wso2/product-micro-integrator (config-tool), wso2/wso2-synapse (OTLPTelemetryManager)
• Affected Feature(s): OpenTelemetry / Jaeger distributed tracing, cloud-native observability

Reproducibility

• Reproducible: Yes
• Environment:
  • Branch: master
  • Product: wso2mi-4.6.0-SNAPSHOT
  • OS: macOS Darwin 24.0.0
  • Java: JVM from MI pack
  • synapse-core version in pack: 4.1.0.wso2v34
• Steps Executed:
  1. Extracted wso2mi-4.6.0-SNAPSHOT.zip
  2. Added [opentelemetry] section to conf/deployment.toml with service_name = "custom-test-service" and enable = true
  3. Started the server (sh micro-integrator.sh)
  4. Server started successfully (log: WSO2 Micro Integrator started in 2.83 seconds)
  5. Inspected conf/synapse.properties after startup
• Expected Behavior:
  • synapse.properties should contain opentelemetry.service.name = custom-test-service
  • Traces sent to Jaeger should carry the service name custom-test-service
• Actual Behavior:
  • synapse.properties contains opentelemetry.service.name = WSO2-SYNAPSE (the hardcoded default)
  • The configured service_name = "custom-test-service" is silently ignored
• Logs/Evidence:

  # conf/synapse.properties after server startup with service_name = "custom-test-service"
  opentelemetry.enable = true
  opentelemetry.host = localhost
  opentelemetry.class = org.apache.synapse.aspects.flow.statistics.tracing.opentelemetry.management.OTLPTelemetryManager
  opentelemetry.service.name = WSO2-SYNAPSE   ← should be "custom-test-service"
  opentelemetry.port = 14250
  opentelemetry.protocol = grpc
  

Root Cause Analysis

There are two interacting defects that together prevent the Jaeger service name from being configurable, causing the mismatch with Grafana dashboards.

Defect 1 — Missing key-mapping in product-micro-integrator

File: distribution/src/resources/config-tool/key-mappings.json (line 130 area)

The key-mappings.json file maps TOML configuration keys from deployment.toml to their target synapse property names. All other [opentelemetry] keys are mapped, but service_name is absent:

// Present mappings:
"opentelemetry.enable":    "synapse_properties.'opentelemetry.enable'",
"opentelemetry.host":      "synapse_properties.'opentelemetry.host'",
"opentelemetry.port":      "synapse_properties.'opentelemetry.port'",
"opentelemetry.protocol":  "synapse_properties.'opentelemetry.protocol'",
// ...

// MISSING:
// "opentelemetry.service_name": "synapse_properties.'opentelemetry.service.name'",

Because the mapping is absent, setting service_name = "custom-test-service" in deployment.toml produces no entry in synapse.properties. Instead, the default.json fallback (WSO2-SYNAPSE) always wins.

Fix location: distribution/src/resources/config-tool/key-mappings.json
Fix: Add the missing entry:

"opentelemetry.service_name": "synapse_properties.'opentelemetry.service.name'",

Defect 2 — OTLPTelemetryManager ignores the synapse property (in wso2-synapse)

File: modules/core/src/main/java/org/apache/synapse/aspects/flow/statistics/tracing/opentelemetry/management/TelemetryConstants.java (line 74–76)

Even if the key-mapping were fixed, the service name would still be hardcoded:

// TelemetryConstants.java
public static final String USER_DEFINED_NAME = System.getenv("SERVICE_NAME");
public static final String SERVICE_NAME =
        USER_DEFINED_NAME != null && !USER_DEFINED_NAME.isEmpty() ? USER_DEFINED_NAME : "WSO2-SYNAPSE";

SERVICE_NAME is a static final, set once at class load from the SERVICE_NAME environment variable; it never reads from synapse properties.

OTLPTelemetryManager.init() (line 143) passes this constant directly:

.setResource(Resource.getDefault().merge(
    TelemetryUtil.getTracerProviderResource(TelemetryConstants.SERVICE_NAME)))

Fix location: wso2-synapse — OTLPTelemetryManager.init() (or TelemetryConstants)
Fix: Read from SynapsePropertiesLoader.getPropertyValue("opentelemetry.service.name", TelemetryConstants.DEFAULT_SERVICE_NAME) instead of using the static final constant.

Original Grafana Case-Mismatch

Even after fixing both defects above, the Grafana dashboards shipped with the MI observability add-on use service name wso2-synapse (lowercase) while MI defaults to WSO2-SYNAPSE (uppercase). These dashboards are maintained in the wso2/docs-mi or wso2/product-mi-tooling repository. When a user navigates from a Grafana panel to Jaeger, the service name wso2-synapse is passed as a filter, but Jaeger holds data indexed under WSO2-SYNAPSE — resulting in no traces being shown without a manual correction.

The permanent fix requires:

1. Fix Defect 1 in product-micro-integrator (key-mapping)
2. Fix Defect 2 in wso2-synapse (code reads from synapse property)
3. Update Grafana dashboards in docs-mi / product-mi-tooling to use WSO2-SYNAPSE (uppercase) — OR change the MI default to wso2-synapse (lowercase) and update the config templates to match

Test Coverage Assessment

• Existing tests covering this path: None found. No unit or integration tests exist for OTLPTelemetryManager, TelemetryConstants, or TelemetryUtil in either repo. No tests verify that service_name from deployment.toml is propagated into the service name used by the OpenTelemetry SDK.
• Coverage gaps identified:
  • No test for key-mappings.json coverage of opentelemetry.service_name
  • No unit test for OTLPTelemetryManager.init() service name resolution
  • No integration test that enables OpenTelemetry and asserts the service name in emitted traces
• Proposed test plan:
  • Unit test (wso2-synapse): Mock SynapsePropertiesLoader and verify OTLPTelemetryManager.getServiceName() returns the value from opentelemetry.service.name synapse property when set; falls back to "WSO2-SYNAPSE" when unset.
  • Unit test (wso2-synapse): Verify TelemetryUtil.getTracerProviderResource(name) sets ServiceAttributes.SERVICE_NAME to the provided name in the returned resource.
  • Integration test (product-micro-integrator): Configure service_name = "test-svc" in deployment.toml, start MI, and assert synapse.properties contains opentelemetry.service.name = test-svc.
  • Negative/edge cases: Ensure service_name is blank or absent in deployment.toml → falls back gracefully to "WSO2-SYNAPSE".

[SasinduDilshara]

Claude Fix Verification Report

Issue: #4200
Verdict: FIXED

Reproduction Steps Executed

1. Built patched synapse-core-4.1.0-wso2v34.jar from wso2-synapse repo (branch fix-issue-4200, checked out from tag v4.1.0-wso2v34) with fixes in:
   • OTLPTelemetryManager.java — now reads service name from synapse properties instead of hardcoded constant
   • TelemetryConstants.java — updated default service name constant
2. Applied patched JAR to patches/patch9999/synapse-core_4.1.0.wso2v34.jar
3. Applied config fix: updated key-mappings.json in repository/resources/conf/ with the missing opentelemetry.service_name mapping entry
4. Added the following to conf/deployment.toml:

   [opentelemetry]
   enable = true
   service_name = "custom-test-service"

5. Started the server (PID 50531) and waited for successful startup confirmation

Result

The bug is FIXED. The configured service_name = "custom-test-service" is now correctly propagated through the config tool into synapse.properties, and the OTLPTelemetryManager now reads the service name from synapse properties at runtime.

Before fix (reported behavior):

opentelemetry.service.name = WSO2-SYNAPSE   ← hardcoded, config ignored

After fix (observed behavior):

opentelemetry.service.name = custom-test-service   ← correctly reads from deployment.toml

Evidence

synapse.properties after server startup (with patch applied):

opentelemetry.enable = true
opentelemetry.host = localhost
opentelemetry.class = org.apache.synapse.aspects.flow.statistics.tracing.opentelemetry.management.OTLPTelemetryManager
opentelemetry.service.name = custom-test-service
opentelemetry.port = 14250
opentelemetry.protocol = grpc

Patch detection in server log:

[2026-04-06 3:53:31,127]  INFO {PatchInstaller perform} - Patch changes detected
[2026-04-06 3:53:31,729]  INFO {PatchUtils applyServicepacksAndPatches} - Backed up plugins to patch0000
[2026-04-06 3:53:31,742]  INFO {PatchUtils checkMD5Checksum} - Patch verification started
[2026-04-06 3:53:31,755]  INFO {PatchUtils checkMD5Checksum} - Patch verification successfully completed

Server startup confirmation:

[2026-04-06 03:53:34,263]  INFO {StartupFinalizer} - WSO2 Micro Integrator started in 3.45 seconds

key-mappings.json fix:

"opentelemetry.service_name": "synapse_properties.'opentelemetry.service.name'",