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

Request: Use abbreviated cloud provider prefixes in log attribute key naming conventions #2503

Closed
damemi opened this issue Apr 20, 2022 · 4 comments · Fixed by #2514
Closed
Assignees
Labels
spec:logs Related to the specification/logs directory

Comments

@damemi
Copy link
Contributor

damemi commented Apr 20, 2022

The current specification for mapping fields in the logs data model recommends prefixing company-specific fields with FQDN-style identifiers, for example com.google.* for GCP-specific attributes.

It was explained in the log sig meeting that this is based on the existing attribute naming conventions.

However, it would be easier to use abbreviated attribute prefixes for cloud providers, eg gcp.*, aws.*, azure.*, etc. There are already some conventions for doing this in logs for AWS and tracing. It is also noted elsewhere in the semantic conventions that cloud providers may have specific key names.

So, to make this more consistent it would be nice if we could officially update the logs data model mappings to use that same style of prefix rather than the reverse-FQDN for cloud providers.

@damemi damemi added the spec:logs Related to the specification/logs directory label Apr 20, 2022
@damemi
Copy link
Contributor Author

damemi commented Apr 20, 2022

/cc @tigrannajaryan
I believe we talked about this on the last log sig call

@pmm-sumo
Copy link
Contributor

pmm-sumo commented Apr 20, 2022

Another example for abbreviated attributed prefixes is resource detection processor (it has e.g. Azure-related attributes that are not currently part of the specification)

This might actually fall under the third bullet in the naming conventions recommendations "The name may be generally applicable to applications in the industry". Some clarification might be helpful there

@pmm-sumo
Copy link
Contributor

Also, there is a bit on resource semantic conventions on cloud providers

@damemi
Copy link
Contributor Author

damemi commented Apr 26, 2022

Opened a PR to make the model changes for GCP attributes: #2514

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec:logs Related to the specification/logs directory
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants