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.

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

Jump to bottom

Introduce log message for not supported annotations for Hints based autodiscover of Elastic Agent #3064

Closed
5 tasks done
gizas opened this issue Jul 12, 2023 · 0 comments
Closed
5 tasks done

Introduce log message for not supported annotations for Hints based autodiscover of Elastic Agent #3064

gizas opened this issue Jul 12, 2023 · 0 comments
Assignees
@gizas
Labels
enhancement New feature or request

Comments

@gizas
Copy link
Contributor

gizas commented Jul 12, 2023 •
edited
Loading

Describe the enhancement:

Hints annotation based autodiscover is based on specific annotations that are provided on pods. In more details, the hints mechanism looks for hints in Kubernetes Pod annotations that have the prefix co.elastic.hints. But what if the user specifies an annotation that is not supported or with a typo, this means that no extra configuration will be applied and the autodiscovery will fail with no errors although users will believe that they have configured everything correctly.

This enhancement will compare the provided annotations against a specific list of supported values and will return

Describe a specific use case for the enhancement or feature:

One of the basic annotations is co.elastic.hints/host: Specifies The host to use for metrics retrieval. We had configured our pod with a typo so the annotation provided was co.elastic.hints/hosts. We lost time trying troubleshooting why this was happening. But if we had a message in logs eg. co.elastic.hints/hosts is not recognised as supported annotation, this would help us troubleshoot quicker

What is the definition of done?

  • Introduce the code that will check the provided annotations against the supported list
  • Provide test evidence that enhancement is working
  • Introduce a new test to log specific message
  • Document any new informations for the users on the 'Troubleshooting' section of Hints Autodiscover page

Tasks
Preview Give feedback
  1. [Beats] Adding support for elastic-agent-autodiscovery v0.6.13 Introduce log message for not supported annotations beats#38213
    Team:Cloudnative-Monitoring
    gizas
  2. [Elastic Agent]-PR- Introduce log message for not supported annotations for Hints based autodiscover #4360
    Team:Cloudnative-Monitoring Team:Elastic-Agent Team:Elastic-Agent-Control-Plane backport-skip
    gizas
  3. Introduce checks for not supported annotations for Hints based autodiscover of Elastic Agent elastic-agent-autodiscover#81
    Team:Cloudnative-Monitoring Team:Elastic-Agent
    gizas
  4. Logshints elastic-agent-autodiscover#83
  5. Adding validate flag for GenerateHints elastic-agent-autodiscover#89
    Team:Cloudnative-Monitoring Team:Elastic-Agent
@gizas gizas added the enhancement New feature or request label Jul 12, 2023
@gizas gizas mentioned this issue Jul 12, 2023
Open
10 tasks
This was referenced Mar 5, 2024
Merged
Merged
Merged
@gizas gizas self-assigned this Mar 7, 2024
gizas added a commit to elastic/elastic-agent-autodiscover that referenced this issue Mar 13, 2024
@gizas
Introduce checks for not supported annotations for Hints based autodi…
7490558 
…scover of Elastic Agent (#81)

This PR relates to elastic/elastic-agent#3064
and provides the checks for the supported hints.
@gizas gizas closed this as completed May 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gizas gizas

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gizas