Aiven-Open / prometheus-exporter-plugin-for-opensearch

Prometheus exporter plugin for OpenSearch & OpenSearch Mixin
Apache License 2.0
110 stars 34 forks source link

Upgrade the plugin to support Opensearch 2.10.0 #226

Closed vijay2308 closed 9 months ago

vijay2308 commented 9 months ago

Upgrade the plugin to support Opensearch 2.10.0 Updates the documentation for plugin version 2.10.0.0

Opensearch 2.10.0 Release Notes

Description

Upgrade the plugin to support Opensearch 2.10.0 Updates the documentation for plugin version 2.10.0.0

Describe your PR and add links to relevant issues.


vinylen commented 9 months ago

I think the commits lacks DCO so the PR CI workflow will fail. If so, read up on how to fix this here.

Also, we might want to squash the commits before merging into main?

vinylen commented 9 months ago

Can we have some attention on this? :) @lukas-vlcek

lukas-vlcek commented 9 months ago

The issue was that OpenSearch 2.10.0 introduced some minor breaking changes (specifically, it moved some classes to different packages). See https://github.com/Aiven-Open/prometheus-exporter-plugin-for-opensearch/pull/230 for details.

lukas-vlcek commented 9 months ago

Hi @vijay2308

thanks for the PR!

When it comes to cutting a new release we have a document (RELEASE_PROCESS.md) to help navigate through the process. We try not to include commits for OpenSearch upgrade and for README.md file update in a single PR. It is safer to make sure we first merge commit with OpenSearch upgrade (making sure CI jobs pass, in this case some coding was needed, see #230) and then we merge the commit with README.md file update which then becomes the "release commit" (it gets the git tag and the repository should at this point in time include everything that is needed to replicate identical build that is found in the Release, see #232).

So, it is more practical to have two separate PRs.

As @vinylen pointed out we also require that all commits have their DCO. I know that for a simple update in markdown document this sounds like we are asking too much but it has its value. Imagine: what if in the future this plugin will get a chance to move under the same organization as OpenSearch itself or into its code base directly (for example when OpenSearch moves under independent foundation) then it will help if all commits are properly DCO signed.

Signing commits costs you nothing, just make sure you have the [user] section in .git/config file properly setup and then use -s option when doing a commit: git commit -s ....

This is what I have in my file:

$ cat .git/config
...
[user]
    name = Lukáš Vlček
    email = lukas.vlcek@aiven.io
...

I am closing this PR for now, please keep your PRs coming 👍