imatefx/typesense-prometheus-exporter Docker 镜像 - 轩辕镜像

Typesense Prometheus Exporter

简介

本仓库包含Typesense-Prometheus-Exporter工具，旨在将Typesense的指标和统计数据以Prometheus格式暴露。

关于Typesense

Typesense是一款开源、容错的搜索引擎，可提供快速且相关的搜索结果。其设计注重简洁易用，提供可扩展、高可用且易于扩展的搜索解决方案。

关于Prometheus

Prometheus是一款开源的系统监控和告警工具包，以其多维数据模型和灵活的查询语言著称，可与多种外部系统集成以实现全面监控。

关于Prometheus Exporters

Prometheus Exporters是将第三方系统指标转换为Prometheus可读格式的工具，对于使用Prometheus监控非Prometheus系统至关重要。

功能说明

该Exporter从配置的Typesense实例获取指标和统计数据，并以Prometheus格式导出，使其能够被Prometheus时序数据库服务器采集和使用。

Docker部署

拉取Docker镜像

从Docker Hub拉取Typesense-Prometheus-Exporter镜像：

docker pull imatefx/typesense-prometheus-exporter

运行Docker容器

使用以下命令在Docker容器中运行Exporter：

docker run --name="example-ts-prom-exp" \
           -e "TYPESENSE_HOST=tshost.example.com" \
           -e "TYPESENSE_PROTOCOL=http" \
           -e "TYPESENSE_API_KEY=tsAPIKEY" \
           -e "TYPESENSE_PORT=8108" \
           -p 8888:8888 \
           imatefx/typesense-prometheus-exporter

此命令配置Typesense-Prometheus-Exporter所需环境变量，并在暴露的8888端口启动Exporter服务。

使用方法

以Prometheus格式暴露Typesense指标和统计数据

使用以下命令运行Exporter以暴露指标：

typesense-prometheus-exporter [OPTIONS] --typesense-host <TYPESENSE_HOST> --typesense-api-key <TYPESENSE_API_KEY>

选项说明

• --typesense-host <TYPESENSE_HOST>: Typesense主机URL（环境变量：TYPESENSE_HOST）。
• --typesense-protocol <TYPESENSE_PROTOCOL>: Typesense协议（环境变量：TYPESENSE_PROTOCOL，默认值：http）。
• --typesense-api-key <TYPESENSE_API_KEY>: Typesense API密钥（环境变量：TYPESENSE_API_KEY）。
• --typesense-port <TYPESENSE_PORT>: Typesense端口号（环境变量：TYPESENSE_PORT，默认值：8108）。
• --exporter-bind-address <EXPORTER_BIND_ADDRESS>: 内部服务器绑定地址（环境变量：EXPORTER_BIND_ADDRESS，默认值：0.0.0.0）。
• --exporter-bind-port <EXPORTER_BIND_PORT>: 内部服务器绑定端口（环境变量：EXPORTER_BIND_PORT，默认值：8888）。

帮助与版本

• -h, --help: 显示帮助信息。
• -V, --version: 显示版本信息。