fix(chart/opensearch): metricsPort and plugins usage info in values.yaml #593

eyenx · 2024-09-10T13:22:28Z

Description

Trying to figure out how to expose metrics, it was obvious that there is the need of installing an additional plugin to be able to expose prometheus metrics over the serviceMonitor. Also the default port exposing the metrics is 9200 and not 9600.

This fixes the default metricsPort and adds a comment about the plugin to be used in values.yaml

Issues Resolved

#590

Check List

Commits are signed per the DCO using --signoff

For any changes to files within Helm chart directories:

Helm chart version bumped
Helm chart CHANGELOG.md updated to reflect change

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

peterzhuamazon · 2024-09-17T17:01:26Z

Note: We are in the review of an older PR now so will come back to this a little later.

eyenx · 2024-10-18T06:00:03Z

@peterzhuamazon any update here? Thanks!

eyenx · 2024-11-05T08:47:41Z

@peterzhuamazon any update here?

peterzhuamazon

Hi @eyenx sorry for the delay we are in a few releases, and just completed 2.18.0 yesterday evening.

peterzhuamazon · 2024-11-06T20:05:18Z

charts/opensearch/values.yaml

-metricsPort: 9600
+metricsPort: 9200


The metrics port here is for Performance Analyzer which utilizes the 9600 port
69daf97

I wonder if we need to add a new var for other metrics?

@eyenx if we want to use this metricsPort (The metrics port (for Performance Analyzer) that Kubernetes will use for the service) then it should be 9600 right ?

I will check tomorrow.

Does the performance Analazer actually expose metrics in prometheus format? If not I would still go for this, ut add 9600 as separate port. How can I enale the performance Analyzer plugin?

I think when you enable PA you would need to query through 9600
https://opensearch.org/docs/latest/monitoring-your-cluster/pa/index/#example-api-query-and-response

As mentioned above, I tried curling 9600, but no response. So this is why I went for 9200 at the end. Did anyone ever got this working?

You would need to separately start the PA process I think.
Not an expert on that tho.

Okay, after having looked at it together with @cfi2017 we came to the conclusion that the metricsPort has nothing to do with the prometheus metrics but rather is to be used in conjuction with Performance Analayzer.

Therefore I'm changing this PR to make sure the ServiceMonitor is deployed to grab metrics from 9200 (httpPort) and keeping the comment about how to install opensearch-prometheus-exporter.

We tried this locally and it just works.

Please another review, but waiting for #594 before bumping the version here. @peterzhuamazon @prudhvigodithi

Signed-off-by: Toni Tauro <[email protected]>

…r 9200 if prom-exporter is used Signed-off-by: Toni Tauro <[email protected]>

Signed-off-by: Toni Tauro <[email protected]>

eyenx · 2024-12-13T15:17:24Z

I would also be very happy to backport this to version 1.x

peterzhuamazon · 2024-12-13T16:35:01Z

Hi @eyenx , most of the team are on vacation soon and sorry for the delay due to recent 1.3.20 release.

I am happy to put this PR on my calendar for next Monday seems like a simple change, but #594 I am afraid I need another maintainer for co-review.

I will try to @ maintainers again but most likely that will be delayed until they are back from holiday. Thanks.

peterzhuamazon · 2024-12-13T16:38:47Z

Also seems like the changelog part needs some updates.

Thanks.

eyenx · 2024-12-13T18:35:37Z

Yes I can add this but it's highly dependant what version will be merged first

muhammeddanish · 2024-12-16T12:45:49Z

Thanks team for working on this!!

I have added below code to my values:

metricsPort: 9200
service:
  metricsPortName: http
plugins:
  enabled: true
  installList:
    - https://github.com/Aiven-Open/prometheus-exporter-plugin-for-opensearch/releases/download/1.3.19.0/prometheus-exporter-1.3.19.0.zip

However, looks like password is needed for authentication and seen below error in prometheus target:

server returned HTTP status 401 Unauthorized

How we can bypass the authentication for scraping the metrics alone?

Best,
Danish

cfi2017 · 2024-12-16T14:24:44Z

Thanks team for working on this!!

I have added below code to my values:
metricsPort: 9200
service:
  metricsPortName: http
plugins:
  enabled: true
  installList:
    - https://github.com/Aiven-Open/prometheus-exporter-plugin-for-opensearch/releases/download/1.3.19.0/prometheus-exporter-1.3.19.0.zip
However, looks like password is needed for authentication and seen below error in prometheus target:
server returned HTTP status 401 Unauthorized
How we can bypass the authentication for scraping the metrics alone?

Best, Danish

The plugin operates on the same port as the main application, so it's protected by the security plugin.
The easiest way here would be to add basic auth to the operator, as suggested in #594

peterzhuamazon · 2024-12-16T18:38:53Z

charts/opensearch/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.27.1
+version: 2.28.1


2.28.0 should be fine I will get it merged today.

Signed-off-by: Peter Zhu <[email protected]>

peterzhuamazon · 2024-12-16T19:09:27Z

Hi @eyenx I have updated your PR to have 2.28.0 version for the charts version.

Let me know what you think.

I will go ahead and merge it by the end of day. Thanks.

peterzhuamazon · 2024-12-17T18:55:26Z

Thanks @eyenx would you mind backport to 1.3?

Thanks.

eyenx requested review from TheAlgo, DandyDeveloper, peterzhuamazon, prudhvigodithi and gaiksaya as code owners September 10, 2024 13:22

github-actions bot added the first-time-contributor label Sep 10, 2024

peterzhuamazon reviewed Nov 6, 2024

View reviewed changes

eyenx mentioned this pull request Nov 15, 2024

[BUG][opensearch] cant connect to metrics endpoint #590

Open

eyenx added 2 commits December 13, 2024 16:09

fix(chart/opensearch): metricsPort and plugins usage info in values.yaml

25896e6

Signed-off-by: Toni Tauro <[email protected]>

fix(metricsPort): use httpPort for metrics, as they are reachable ove…

f3409a4

…r 9200 if prom-exporter is used Signed-off-by: Toni Tauro <[email protected]>

eyenx force-pushed the fix/chart-opensearch/serviceMonitor-right-port-and-docs branch from 76017aa to f3409a4 Compare December 13, 2024 15:13

fix(values): trailing spaces

1d4eef5

Signed-off-by: Toni Tauro <[email protected]>

peterzhuamazon reviewed Dec 16, 2024

View reviewed changes

Update version changelog

baea0a7

Signed-off-by: Peter Zhu <[email protected]>

peterzhuamazon approved these changes Dec 16, 2024

View reviewed changes

muhammeddanish mentioned this pull request Dec 17, 2024

feat(chart/opensearch): add ability for serviceMonitor basicauth #594

Open

3 tasks

peterzhuamazon merged commit 61d7961 into opensearch-project:main Dec 17, 2024
8 checks passed

eyenx mentioned this pull request Dec 19, 2024

[opensearch/1.x] feat(opensearch): update chart to version 1.33.0 with ServiceMonitor fix #636

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(chart/opensearch): metricsPort and plugins usage info in values.yaml #593

fix(chart/opensearch): metricsPort and plugins usage info in values.yaml #593

eyenx commented Sep 10, 2024 •

edited

Loading

peterzhuamazon commented Sep 17, 2024

eyenx commented Oct 18, 2024

eyenx commented Nov 5, 2024

peterzhuamazon left a comment •

edited

Loading

peterzhuamazon Nov 6, 2024

peterzhuamazon Nov 6, 2024

prudhvigodithi Nov 6, 2024

eyenx Nov 14, 2024

eyenx Nov 15, 2024

peterzhuamazon Nov 15, 2024

eyenx Nov 22, 2024

peterzhuamazon Nov 25, 2024

eyenx Dec 13, 2024

eyenx Dec 13, 2024

eyenx commented Dec 13, 2024

peterzhuamazon commented Dec 13, 2024 •

edited

Loading

peterzhuamazon commented Dec 13, 2024

eyenx commented Dec 13, 2024

muhammeddanish commented Dec 16, 2024

cfi2017 commented Dec 16, 2024 •

edited

Loading

peterzhuamazon Dec 16, 2024

peterzhuamazon commented Dec 16, 2024

peterzhuamazon commented Dec 17, 2024

fix(chart/opensearch): metricsPort and plugins usage info in values.yaml #593

fix(chart/opensearch): metricsPort and plugins usage info in values.yaml #593

Conversation

eyenx commented Sep 10, 2024 • edited Loading

Description

Issues Resolved

Check List

peterzhuamazon commented Sep 17, 2024

eyenx commented Oct 18, 2024

eyenx commented Nov 5, 2024

peterzhuamazon left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eyenx commented Dec 13, 2024

peterzhuamazon commented Dec 13, 2024 • edited Loading

peterzhuamazon commented Dec 13, 2024

eyenx commented Dec 13, 2024

muhammeddanish commented Dec 16, 2024

cfi2017 commented Dec 16, 2024 • edited Loading

Choose a reason for hiding this comment

peterzhuamazon commented Dec 16, 2024

peterzhuamazon commented Dec 17, 2024

eyenx commented Sep 10, 2024 •

edited

Loading

peterzhuamazon left a comment •

edited

Loading

peterzhuamazon commented Dec 13, 2024 •

edited

Loading

cfi2017 commented Dec 16, 2024 •

edited

Loading