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

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions charts/opensearch/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
### Security
---
## [2.24.1]
### Added
### Changed
### Deprecated
### Removed
### Fixed
- `metricsPort` used and explanation about plugins to be used for metrics
### Security
---
## [2.24.0]
### Added
- Ability to add additional `labels` to `serviceMonitor`
Expand Down Expand Up @@ -476,8 +485,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed
### Security

[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.24.0...HEAD
[2.24.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.23.1...opensearch-2.24.0
[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.24.1...HEAD
[2.24.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.24.0...opensearch-2.24.1
[2.24.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.23.2...opensearch-2.24.0
[2.23.2]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.23.1...opensearch-2.23.2
[2.23.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.23.0...opensearch-2.23.1
[2.23.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.22.1...opensearch-2.23.0
Expand Down
2 changes: 1 addition & 1 deletion charts/opensearch/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.24.0
version: 2.24.1

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
8 changes: 7 additions & 1 deletion charts/opensearch/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@
protocol: https
httpPort: 9200
transportPort: 9300
metricsPort: 9600
metricsPort: 9200
Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

@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 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will check tomorrow.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

So I enabled the plugin following the guide, but I still see no metrics when I try to curl the Port

opensearch-cluster-master-0:/$ curl localhost:9600/_plugins/_performanceanalyzer/metrics  -vvv
06:45:58.738363 [0-x] == Info: [READ] client_reset, clear readers
06:45:58.738550 [0-0] == Info: Host localhost:9600 was resolved.
06:45:58.738685 [0-0] == Info: IPv6: ::1
06:45:58.738793 [0-0] == Info: IPv4: 127.0.0.1
06:45:58.738918 [0-0] == Info: [SETUP] added
06:45:58.739051 [0-0] == Info:   Trying [::1]:9600...
06:45:58.939510 [0-0] == Info:   Trying 127.0.0.1:9600...

opensearch-cluster-master-0:/$ curl -k https://localhost:9200/_plugins/_performanceanalyzer/config -u user:pw
{"performanceAnalyzerEnabled":true,"rcaEnabled":false,"loggingEnabled":false,"shardsPerCollection":0,"batchMetricsEnabled":false,"threadContentionMonitoringEnabled":false,"batchMetricsRetentionPeriodMinutes":7}

Copy link
Member

Choose a reason for hiding this comment

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

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

httpHostPort: ""
transportHostPort: ""

Expand Down Expand Up @@ -532,6 +532,12 @@

# ServiceMonitor Configuration for Prometheus
# Enabling this option will create a ServiceMonitor resource that allows Prometheus to scrape metrics from the OpenSearch service.
# This only creates the serviceMonitor, to actually have metrics Make sure to install the prometheus-exporter plugin needed for

Check failure on line 535 in charts/opensearch/values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (1.19.16) 

[trailing-spaces] trailing spaces

Check failure on line 535 in charts/opensearch/values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (1.21.14) 

[trailing-spaces] trailing spaces

Check failure on line 535 in charts/opensearch/values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (1.22.9) 

[trailing-spaces] trailing spaces

Check failure on line 535 in charts/opensearch/values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (1.23.12) 

[trailing-spaces] trailing spaces

Check failure on line 535 in charts/opensearch/values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (1.24.7) 

[trailing-spaces] trailing spaces

Check failure on line 535 in charts/opensearch/values.yaml

View workflow job for this annotation

GitHub Actions / lint-test (1.25.2) 

[trailing-spaces] trailing spaces
# serving metrics over the `.Values.plugins` value:
# plugins:
# enabled: true
# installList:
# - https://github.com/aiven/prometheus-exporter-plugin-for-opensearch/releases/download/x.x.x.x/prometheus-exporter-x.x.x.x.zip
serviceMonitor:
# Set to true to enable the ServiceMonitor resource
enabled: false
Expand Down
Loading