Download postgres_exporter - download do código-fonte postgres

Exportador de servidor PostgreSQL

Exportador Prometheus para métricas de servidor PostgreSQL.

Versões do PostgreSQL testadas pela CI: 11 , 12 , 13 , 14 , 15 , 16

Início rápido

Este pacote está disponível para Docker:

 # Start an example database
docker run --net=host -it --rm -e POSTGRES_PASSWORD=password postgres
# Connect to it
docker run 
  --net=host 
  -e DATA_SOURCE_URI="localhost:5432/postgres?sslmode=disable" 
  -e DATA_SOURCE_USER=postgres 
  -e DATA_SOURCE_PASS=password 
  quay.io/prometheuscommunity/postgres-exporter

Teste com:

curl " http://localhost:9187/metrics "

Exemplo de configuração do Prometheus:

 scrape_configs :
  - job_name : postgres
    static_configs :
      - targets : ["127.0.0.1:9187"] # Replace IP with the hostname of the docker container if you're running the container in a separate network

Agora use o DATA_SOURCE_PASS_FILE com um arquivo montado contendo a senha para evitar que a senha esteja em uma variável de ambiente.

O processo do contêiner é executado com uid/gid 65534 (importante para permissões de arquivo).

Suporte multialvo (BETA)

Este recurso está em versão beta e pode exigir alterações em versões futuras. Comentários são bem-vindos.

Este exportador suporta o padrão multi-alvo. Isso permite executar uma única instância deste exportador para vários destinos do postgres. A utilização da funcionalidade multi-alvo deste exportador é opcional e destina-se a casos em que é impossível instalar o exportador como sidecar, por exemplo, serviços gerenciados por SaaS.

Para usar a funcionalidade de vários destinos, envie uma solicitação http para o endpoint /probe?target=foo:5432 onde o destino está definido como o DSN da instância do postgres da qual extrair métricas.

Para evitar colocar informações confidenciais como nome de usuário e senha na URL, módulos de autenticação pré-configurados são suportados por meio da seção auth_modules do arquivo de configuração. auth_modules para DSNs pode ser usado com o terminal /probe especificando o parâmetro http ?auth_module=foo .

Exemplo de configuração do Prometheus:

 scrape_configs :
  - job_name : ' postgres '
    static_configs :
      - targets :
        - server1:5432
        - server2:5432
    metrics_path : /probe
    params :
      auth_module : [foo]
    relabel_configs :
      - source_labels : [__address__]
        target_label : __param_target
      - source_labels : [__param_target]
        target_label : instance
      - target_label : __address__
        replacement : 127.0.0.1:9116  # The postgres exporter's real hostname:port.

Arquivo de configuração

O arquivo de configuração controla o comportamento do exportador. Ele pode ser definido usando o sinalizador de linha de comando --config.file e o padrão é postgres_exporter.yml .

auth_modules

Esta seção define parâmetros predefinidos de autenticação e conexão para uso no endpoint multialvo. auth_modules é um mapa de módulos com a chave sendo o identificador que pode ser usado no endpoint /probe . Atualmente apenas o tipo userpass é suportado.

Exemplo:

 auth_modules :
  foo1 : # Set this to any name you want
    type : userpass
    userpass :
      username : first
      password : firstpass
    options :
      # options become key=value parameters of the DSN
      sslmode : disable

Construindo e funcionando

 git clone https://github.com/prometheus-community/postgres_exporter.git
cd postgres_exporter
make build
./postgres_exporter <flags>

Para construir a imagem Docker:

 make promu
promu crossbuild -p linux/amd64 -p linux/armv7 -p linux/arm64 -p linux/ppc64le
make docker

Isso criará a imagem do docker como prometheuscommunity/postgres_exporter:${branch} .

Bandeiras

help Mostra ajuda contextual (tente também --help-long e --help-man).
[no-]collector.database Habilita o coletor database (padrão: habilitado).
[no-]collector.database_wraparound Habilite o coletor database_wraparound (padrão: desabilitado).
[no-]collector.locks Habilita o coletor locks (padrão: habilitado).
[no-]collector.long_running_transactions Habilite o coletor long_running_transactions (padrão: desabilitado).
[no-]collector.postmaster Habilita o coletor postmaster (padrão: desabilitado).
[no-]collector.process_idle Habilite o coletor process_idle (padrão: desabilitado).
[no-]collector.replication Habilita o coletor replication (padrão: habilitado).
[no-]collector.replication_slot Habilite o coletor replication_slot (padrão: habilitado).
[no-]collector.stat_activity_autovacuum Habilite o coletor stat_activity_autovacuum (padrão: desabilitado).
[no-]collector.stat_bgwriter Habilite o coletor stat_bgwriter (padrão: habilitado).
[no-]collector.stat_database Habilite o coletor stat_database (padrão: habilitado).
[no-]collector.stat_statements Habilite o coletor stat_statements (padrão: desabilitado).
[no-]collector.stat_user_tables Habilite o coletor stat_user_tables (padrão: habilitado).
[no-]collector.stat_wal_receiver Habilite o coletor stat_wal_receiver (padrão: desabilitado).
[no-]collector.statio_user_indexes Habilite o coletor statio_user_indexes (padrão: desabilitado).
[no-]collector.statio_user_tables Habilite o coletor statio_user_tables (padrão: habilitado).
[no-]collector.wal Habilite o coletor wal (padrão: habilitado).
[no-]collector.xlog_location Habilite o coletor xlog_location (padrão: desabilitado).
config.file Defina o caminho do arquivo de configuração. O padrão é postgres_exporter.yml
web.systemd-socket Use ouvintes de ativação de soquete systemd em vez de ouvintes de porta (somente Linux). O padrão é false
web.listen-address Endereço para escutar interface web e telemetria. O padrão é :9187 .
web.config.file Arquivo de configuração para usar TLS e/ou autenticação básica. O formato do arquivo está descrito no repositório do exporter-toolkit.
web.telemetry-path Caminho sob o qual expor métricas. O padrão é /metrics .
disable-default-metrics Use apenas métricas fornecidas por queries.yaml via --extend.query-path . O padrão é false .
disable-settings-metrics Use o sinalizador se não quiser copiar pg_settings . O padrão é false .
auto-discover-databases (DEPRECATED) Se os bancos de dados em um servidor devem ser descobertos dinamicamente. O padrão é false .
extend.query-path (DEPRECATED) Caminho para um arquivo YAML contendo consultas personalizadas para execução. Confira queries.yaml para exemplos do formato.
dumpmaps Não execute - imprima a representação interna dos mapas métricos. Útil ao depurar um arquivo de consultas personalizado.
constantLabels (DEPRECATED) Rótulos a serem definidos em todas as métricas. Uma lista de pares label=value , separados por vírgulas.
version Mostra a versão do aplicativo.
exclude-databases (DEPRECATED) Uma lista de bancos de dados a serem removidos quando autoDiscoverDatabases estiver ativado.
include-databases (DEPRECATED) Uma lista de bancos de dados a serem incluídos somente quando autoDiscoverDatabases estiver habilitado.
log.level Defina o nível de registro: um de debug , info , warn , error .
log.format Defina o formato do log: um entre logfmt , json .

Variáveis de ambiente

As seguintes variáveis de ambiente configuram o exportador:

DATA_SOURCE_NAME o formato legado padrão. Aceita argumentos do formulário URI e do formulário chave=valor. O URI pode conter o nome de usuário e a senha para conexão.
DATA_SOURCE_URI uma alternativa a DATA_SOURCE_NAME que aceita exclusivamente o nome do host sem um componente de nome de usuário e senha. Por exemplo, my_pg_hostname ou my_pg_hostname:5432/postgres?sslmode=disable .
DATA_SOURCE_URI_FILE O mesmo que acima, mas lê o URI de um arquivo.
DATA_SOURCE_USER Ao usar DATA_SOURCE_URI , esta variável de ambiente é usada para especificar o nome de usuário.
DATA_SOURCE_USER_FILE O mesmo, mas lê o nome de usuário de um arquivo.
DATA_SOURCE_PASS Ao usar DATA_SOURCE_URI , esta variável de ambiente é usada para especificar a senha para conexão.
DATA_SOURCE_PASS_FILE O mesmo que acima, mas lê a senha de um arquivo.
PG_EXPORTER_WEB_TELEMETRY_PATH Caminho sob o qual expor métricas. O padrão é /metrics .
PG_EXPORTER_DISABLE_DEFAULT_METRICS Use apenas métricas fornecidas por queries.yaml . O valor pode ser true ou false . O padrão é false .
PG_EXPORTER_DISABLE_SETTINGS_METRICS Use o sinalizador se não quiser copiar pg_settings . O valor pode ser true ou false . O padrão é false .
PG_EXPORTER_AUTO_DISCOVER_DATABASES (DEPRECATED) Se os bancos de dados em um servidor devem ser descobertos dinamicamente. O valor pode ser true ou false . O padrão é false .
PG_EXPORTER_EXTEND_QUERY_PATH Caminho para um arquivo YAML contendo consultas personalizadas a serem executadas. Confira queries.yaml para exemplos do formato.
PG_EXPORTER_CONSTANT_LABELS (DEPRECATED) Rótulos a serem definidos em todas as métricas. Uma lista de pares label=value , separados por vírgulas.
PG_EXPORTER_EXCLUDE_DATABASES (DEPRECATED) Uma lista separada por vírgulas de bancos de dados a serem removidos quando autoDiscoverDatabases estiver habilitado. O padrão é uma string vazia.
PG_EXPORTER_INCLUDE_DATABASES (DEPRECATED) Uma lista de bancos de dados separados por vírgula para incluir somente quando autoDiscoverDatabases estiver habilitado. O padrão é uma string vazia, significa permitir todos.
PG_EXPORTER_METRIC_PREFIX Um prefixo a ser usado para cada uma das métricas padrão exportadas pelo postgres-exporter. O padrão é pg

As configurações definidas pelas variáveis de ambiente começando com PG_ serão substituídas pelo sinalizador CLI correspondente, se fornecido.

Configurando o nome da fonte de dados do servidor Postgres

O nome da fonte de dados do servidor PostgreSQL deve ser definido por meio da variável de ambiente DATA_SOURCE_NAME .

Para executá-lo localmente em uma instalação padrão do Debian/Ubuntu, isso funcionará (transponha para o script de inicialização conforme apropriado):

 sudo -u postgres DATA_SOURCE_NAME="user=postgres host=/var/run/postgresql/ sslmode=disable" postgres_exporter

Além disso, você pode definir uma lista de fontes para extrair instâncias diferentes da configuração de um exportador. Basta definir uma string separada por vírgula.

 sudo -u postgres DATA_SOURCE_NAME="port=5432,port=6432" postgres_exporter

Consulte o módulo github.com/lib/pq para outras maneiras de formatar a string de conexão.

Adicionando novas métricas

O exportador tentará exportar dinamicamente métricas adicionais se forem adicionadas no futuro, mas serão marcadas como "sem tipo". Mapas de métricas adicionais podem ser facilmente criados a partir da documentação do Postgres, copiando as tabelas e usando o seguinte trecho Python:

 x = """tab separated raw text of a documentation table"""
for l in StringIO ( x ):
    column , ctype , description = l . split ( ' t ' )
    print """"{0}" : {{ prometheus.CounterValue, prometheus.NewDesc("pg_stat_database_{0}", "{2}", nil, nil) }}, """ . format ( column . strip (), ctype , description . strip ())

Ajuste o valor do tipo de valor prometheus resultante de forma adequada. Isso ajuda a criar métricas ricas de autodocumentação para o exportador.

Adicionando novas métricas por meio de um arquivo de configuração (DESCONTINUADO)

Este recurso está obsoleto em favor das funções de coletor integradas. Para monitoramento genérico de banco de dados SQL, consulte o arquivo sql_exporter.

O argumento de linha de comando -extend.query-path especifica um arquivo YAML contendo consultas adicionais a serem executadas. Alguns exemplos são fornecidos em queries.yaml.

Desativando métricas padrão

Para trabalhar com versões do postgres não suportadas oficialmente (por exemplo, 8.2.15) ou variantes do postgres (por exemplo, Greenplum), você pode desabilitar as métricas padrão com o sinalizador --disable-default-metrics . Isso remove todas as métricas integradas e usa apenas métricas definidas por consultas no arquivo queries.yaml que você fornece (portanto, você deve fornecer um, caso contrário, o exportador não retornará nada além de status internos e não seu banco de dados).

Descobrir bancos de dados automaticamente (OBSOLETO)

Para extrair métricas de todos os bancos de dados em um servidor de banco de dados, os DSNs do banco de dados podem ser descobertos dinamicamente por meio do sinalizador --auto-discover-databases . Quando verdadeiro, SELECT datname FROM pg_database WHERE datallowconn = true AND datistemplate = false and datname != current_database() é executado para todos os DSNs configurados. A partir do resultado é criado um novo conjunto de DSNs para os quais as métricas são extraídas.

Além disso, a opção --exclude-databases adiciona a possibilidade de filtrar o resultado da descoberta automática para descartar bancos de dados desnecessários.

Se quiser incluir apenas um subconjunto de bancos de dados, você pode usar a opção --include-databases . O exportador ainda faz solicitação para a tabela pg_database , mas só faz a extração se o banco de dados estiver na lista de inclusão.

Executando como não superusuário

Para poder coletar métricas de visualizações pg_stat* como não superusuários nas versões do servidor PostgreSQL >= 10, você pode conceder as funções integradas pg_monitor ou pg_read_all_stats ao usuário. Se precisar monitorar servidores PostgreSQL mais antigos, você terá que criar funções e visualizações como superusuário e atribuir permissões separadamente a elas.

 -- To use IF statements, hence to be able to check if the user exists before
-- attempting creation, we need to switch to procedural SQL (PL/pgSQL)
-- instead of standard SQL.
-- More: https://www.postgresql.org/docs/9.3/plpgsql-overview.html
-- To preserve compatibility with <9.0, DO blocks are not used; instead,
-- a function is created and dropped.
CREATE OR REPLACE FUNCTION __tmp_create_user () returns void as $$
BEGIN
  IF NOT EXISTS (
          SELECT                       -- SELECT list can stay empty for this
          FROM   pg_catalog . pg_user
          WHERE  usename = ' postgres_exporter ' ) THEN
    CREATE USER postgres_exporter ;
  END IF;
END;
$$ language plpgsql;

SELECT __tmp_create_user();
DROP FUNCTION __tmp_create_user();

ALTER USER postgres_exporter WITH PASSWORD ' password ' ;
ALTER USER postgres_exporter SET SEARCH_PATH TO postgres_exporter,pg_catalog;

-- If deploying as non-superuser (for example in AWS RDS), uncomment the GRANT
-- line below and replace <MASTER_USER> with your root user.
-- GRANT postgres_exporter TO <MASTER_USER>;

GRANT CONNECT ON DATABASE postgres TO postgres_exporter;

Execute o seguinte comando se você usar versões do PostgreSQL >= 10

 GRANT pg_monitor to postgres_exporter;

Execute os seguintes comandos SQL somente se você usar versões do PostgreSQL anteriores a 10. No PostgreSQL, as visualizações são executadas com as permissões do usuário que as criou para que possam atuar como barreiras de segurança. Funções precisam ser criadas para compartilhar esses dados com o não superusuário. Apenas a criação das visualizações deixará de fora os dados mais importantes.

 CREATE SCHEMA IF NOT EXISTS postgres_exporter;
GRANT USAGE ON SCHEMA postgres_exporter TO postgres_exporter;

CREATE OR REPLACE FUNCTION get_pg_stat_activity () RETURNS SETOF pg_stat_activity AS
$$ SELECT * FROM pg_catalog . pg_stat_activity ; $$
LANGUAGE sql
VOLATILE
SECURITY DEFINER;

CREATE OR REPLACE VIEW postgres_exporter .pg_stat_activity
AS
  SELECT * from get_pg_stat_activity();

GRANT SELECT ON postgres_exporter . pg_stat_activity TO postgres_exporter;

CREATE OR REPLACE FUNCTION get_pg_stat_replication () RETURNS SETOF pg_stat_replication AS
$$ SELECT * FROM pg_catalog . pg_stat_replication ; $$
LANGUAGE sql
VOLATILE
SECURITY DEFINER;

CREATE OR REPLACE VIEW postgres_exporter .pg_stat_replication
AS
  SELECT * FROM get_pg_stat_replication();

GRANT SELECT ON postgres_exporter . pg_stat_replication TO postgres_exporter;

CREATE EXTENSION IF NOT EXISTS pg_stat_statements;
CREATE OR REPLACE FUNCTION get_pg_stat_statements () RETURNS SETOF pg_stat_statements AS
$$ SELECT * FROM public . pg_stat_statements ; $$
LANGUAGE sql
VOLATILE
SECURITY DEFINER;

CREATE OR REPLACE VIEW postgres_exporter .pg_stat_statements
AS
  SELECT * FROM get_pg_stat_statements();

GRANT SELECT ON postgres_exporter . pg_stat_statements TO postgres_exporter;

OBSERVAÇÃO
Lembre-se de usar o nome do banco de dados postgres na string de conexão:
 DATA_SOURCE_NAME=postgresql://postgres_exporter:password@localhost:5432/postgres?sslmode=disable

Executando os testes

 # Run the unit tests
make test
# Start the test database with docker
docker run -p 5432:5432 -e POSTGRES_DB=circle_test -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=test -d postgres
# Run the integration tests
DATA_SOURCE_NAME='postgresql://postgres:test@localhost:5432/circle_test?sslmode=disable' GOOPTS='-v -tags integration' make test

Expandir

postgres_exporter

Exportador de servidor PostgreSQL

Início rápido

Suporte multialvo (BETA)

Arquivo de configuração

auth_modules

Construindo e funcionando

Bandeiras

Variáveis de ambiente

Configurando o nome da fonte de dados do servidor Postgres

Adicionando novas métricas

Adicionando novas métricas por meio de um arquivo de configuração (DESCONTINUADO)

Desativando métricas padrão

Descobrir bancos de dados automaticamente (OBSOLETO)

Executando como não superusuário

Executando os testes

OpenCore_NO_ACPI_Build

nspanel_pro_tools_apk

zkwork_aleo_gpu_worker

replit exporter

nextcloud_share_url_downloader

Mecanismo de análise de dados Lihua versão gratuita 3.0_search_navigation_collection_public parecer_ranking_api

chat.petals.dev

GPT Prompt Templates

GPTyped

waymo open dataset

SmartTube

Sunamu

wp functions

waymo open dataset

slugify

postgres_exporter

Exportador de servidor PostgreSQL

Início rápido

Suporte multialvo (BETA)

Arquivo de configuração

auth_modules

Construindo e funcionando

Bandeiras

Variáveis ​​de ambiente

Configurando o nome da fonte de dados do servidor Postgres

Adicionando novas métricas

Adicionando novas métricas por meio de um arquivo de configuração (DESCONTINUADO)

Desativando métricas padrão

Descobrir bancos de dados automaticamente (OBSOLETO)

Executando como não superusuário

Executando os testes

Variáveis de ambiente