Prometheus Exporter Plugin for OpenSearch 使用教程
1. 项目的目录结构及介绍
prometheus-exporter-plugin-for-opensearch/
├── bin
│ └── opensearch-plugin
├── config
│ └── opensearch.yml
├── lib
│ └── prometheus-exporter-plugin-for-opensearch.jar
├── src
│ ├── main
│ │ └── java
│ │ └── ...
│ └── test
│ └── java
│ └── ...
├── README.md
├── LICENSE
└── gradle
└── ...
- bin: 包含插件的安装和卸载脚本。
- config: 包含配置文件
opensearch.yml
,用于设置静态和动态配置。 - lib: 包含插件的JAR文件。
- src: 包含项目的源代码,分为
main
和test
两个部分。 - README.md: 项目说明文档。
- LICENSE: 项目许可证。
- gradle: 包含Gradle构建脚本和相关文件。
2. 项目的启动文件介绍
项目的启动文件位于 bin
目录下,主要文件是 opensearch-plugin
。该文件用于安装和卸载插件。
安装插件
./bin/opensearch-plugin install https://github.com/Aiven-Open/prometheus-exporter-plugin-for-opensearch/releases/download/v2.16.0.0/prometheus-exporter-2.16.0.0.zip
卸载插件
./bin/opensearch-plugin remove prometheus-exporter
3. 项目的配置文件介绍
配置文件位于 config
目录下,主要文件是 opensearch.yml
。该文件用于设置插件的静态和动态配置。
静态配置
静态配置在 opensearch.yml
中设置,例如:
prometheus.metric_name_prefix: "opensearch_"
动态配置
动态配置可以通过 REST API 更新,例如:
index_level_metrics: true
可以通过以下API更新:
curl -X PUT "http://localhost:9200/_cluster/settings" -H 'Content-Type: application/json' -d'
{
"persistent": {
"index_level_metrics": true
}
}'
以上是 Prometheus Exporter Plugin for OpenSearch 的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助!