Skip to content
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.

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

Use appId as SERVICE_NAME if embrace.disableMappingFileUpload=true #1920

Open
3 tasks done
natintosh opened this issue Feb 18, 2025 · 0 comments
Open
3 tasks done

Use appId as SERVICE_NAME if embrace.disableMappingFileUpload=true #1920

natintosh opened this issue Feb 18, 2025 · 0 comments

Comments

@natintosh
Copy link

SDK Feature Request

Describe the problem you’re trying to solve
Currently, the library defaults the service name to the Embrace library package name. This default behavior makes it difficult to distinguish between different applications. Without a clear, service.name, it becomes challenging to correlate telemetry with the correct application instance, leading to confusion in diagnostics and reporting.

Describe the ideal solution
The ideal solution is to use the appId as the service name when embrace.disableMappingFileUpload=true, while ignoring the minLength and maxLength constraints on app_id from embrace-config.json. This would ensure:

  • Consistency: The service name accurately reflects the application's identifier, making it easier to distinguish between different applications.
  • Clarity in Reporting: Teams can reliably correlate telemetry data with the correct application, improving diagnostics and operational insights.
  • Future-Proofing: This approach lays the groundwork for potential future enhancements, such as allowing customers to explicitly define a custom app name or version.

The change aligns with the following discussion:

"Also, this is typically the name of the app. It's not something we capture is it? This is fine for now, but we might want to allow customers to specify an app name - or we default to the appId or something. Same thing for appVersion."
Originally posted by @bidetofevil in #375 (comment)

Describe alternatives you’ve considered or workarounds you’re using
We've explored the option of forking and making modifications, but this approach is error-prone due to the numerous interdependent components in the system. We also considered using addSessionProperty, but it may not provide the necessary consistency across telemetry data.

Additional context
Adopting this change will simplify the integration process for developers and ensure that the telemetry data being exported accurately reflects the intended application. This is particularly important for organizations using custom OpenTelemetry setups, where the clarity of service identification is crucial for operational monitoring and troubleshooting.

We greatly appreciate the team's ongoing efforts and contributions to the OpenTelemetry community. Thank you!


Checklist

  • I have checked the SDK documentation to confirm this feature does not already exist
  • I have searched open issues to ensure this feature has not already been requested
  • I have included all necessary details to understand the SDK-specific use case
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy