Skip to content

Universal Profiling Agent: add project_id#11707

Merged
florianl merged 0 commit intomainfrom
up-agent-project-id
Nov 19, 2024
Merged

Universal Profiling Agent: add project_id#11707
florianl merged 0 commit intomainfrom
up-agent-project-id

Conversation

@florianl
Copy link
Member

Proposed commit message

Add project ID as optional configuration option.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

@florianl florianl added the enhancement New feature or request label Nov 12, 2024
@florianl florianl requested a review from a team as a code owner November 12, 2024 09:11
@florianl florianl force-pushed the up-agent-project-id branch 2 times, most recently from 44739c5 to 48d0402 Compare November 12, 2024 09:12
@elastic-sonarqube
Copy link

@elasticmachine
Copy link

💚 Build Succeeded

@andrewkroh andrewkroh added the Integration:universal_profiling_agent Universal Profiling Agent label Nov 12, 2024
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The field profiling-project.id in ES is already a keyword (indexed string).
Should we accept a string in the agent as well instead of limiting it to an integer?
The required change in the collector is tiny, as projectID is already used as a string except for Metrics.ProjectID.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accepting a string for a numeric value sounds like a overhead to me, that should be avoided. From a usability point of view, if the accepted string is not a numeric value, where and when does it let the user know about the expectation and what is the expected failing state and how can a user recover form this workflow? How the value is used internally in the backend should not matter to the user.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The benefit for the user would be to have a human understandable string that can be memorized easier. If you use 1, 2, 3... as the projectID, can you still remember what 34 stands for after a while? Instead you could have "obs-testing-metrics-cluster" or whatever you like.
Constraints and expectations need to be documented and checked at the agent and collector side.

How the value is used internally in the backend should not matter to the user.

To clarify, just meant to describe that the required changes are minimal.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is just my personal opinion, but the use of project ID is an internal detail that users should not care about. for logical separation, there are tags (strings) that users can apply and are used to with every other concept of deployment.
Project ID is based on a concept, that is SaaS centric but doesn't fit well in the current integration anymore.

@florianl florianl merged commit d74bd10 into main Nov 19, 2024
@florianl florianl deleted the up-agent-project-id branch November 19, 2024 07:42
@elastic-vault-github-plugin-prod

Package profiler_agent - 8.17.0 containing this change is available at https://epr.elastic.co/package/profiler_agent/8.17.0/

qcorporation pushed a commit that referenced this pull request Feb 3, 2025
Signed-off-by: Florian Lehner <florian.lehner@elastic.co>
harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 4, 2025
Signed-off-by: Florian Lehner <florian.lehner@elastic.co>
qcorporation pushed a commit that referenced this pull request Feb 4, 2025
Signed-off-by: Florian Lehner <florian.lehner@elastic.co>
harnish-crest-data pushed a commit to chavdaharnish/integrations that referenced this pull request Feb 5, 2025
Signed-off-by: Florian Lehner <florian.lehner@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request Integration:universal_profiling_agent Universal Profiling Agent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants