Instale & configure o NRDOT para MySQL auto-hospedado

Visualização

Ainda estamos trabalhando nesse recurso, mas adoraríamos que você experimentasse!

Atualmente, esse recurso é fornecido como parte de uma prévia, de acordo com nossas políticas de pré-lançamento.

Configurar o monitoramento do MySQL usando o NRDOT Collector em ambientes auto-hospedados, incluindo servidores físicos, máquinas virtuais e instalações independentes.

Pré-requisitos

Antes de instalar, certifique-se de ter:

Uma chave de licença da New Relic.
Acesso administrativo à sua instância do MySQL.
Conectividade de rede entre o host onde o Collector NRDOT é instalado e o seu banco de dados MySQL.
Conectividade de rede para a documentação dos endpoints OTLP da New Relic
Esta integração está disponível como parte do programa de pré-visualização pública da New Relic. Verifique com seu gerente da organização para fazer a adesão na página Previews & Trials.
Para versões compatíveis do MySQL, permissões necessárias e requisitos de performance_schema, consulte Compatibilidade e pré-requisitos.

Configurar o NRDOT Collector

Instale o NRDOT Collector no sistema:

Para sistemas Debian/Ubuntu, execute:
bash
```
$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_amd64.deb" --output nrdot-collector.deb && sudo dpkg -i nrdot-collector.deb
```

Para sistemas RHEL/CentOS/OEL, execute:

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_x86_64.rpm" --output nrdot-collector.rpm && sudo rpm -ivh nrdot-collector.rpm

Para sistemas Debian/Ubuntu, execute:

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_arm64.deb" --output nrdot-collector.deb && sudo dpkg -i nrdot-collector.deb

Para sistemas RHEL/CentOS/OEL, execute:

bash

$NRDOT_VERSION=$(curl -s https://api.github.com/repos/newrelic/nrdot-collector-releases/releases/latest | grep '"tag_name":' | awk -F'"' '{print $4}') && curl -L "https://github.com/newrelic/nrdot-collector-releases/releases/download/${NRDOT_VERSION}/nrdot-collector_${NRDOT_VERSION}_linux_arm64.rpm" --output nrdot-collector.rpm && sudo rpm -ivh nrdot-collector.rpm

Configurar usuário do banco de dados

Crie um usuário de monitoramento com os privilégios necessários para a sua instância de banco de dados MySQL.

Para criar um usuário de monitoramento, execute o seguinte comando no banco de dados MySQL:
```
CREATE USER '<YOUR_DB_USERNAME>'@'%' IDENTIFIED BY '<YOUR_DB_PASSWORD>';
```
Para coletar amostras de consulta e as principais consultas, conceda os seguintes privilégios ao usuário de monitoramento:
```
GRANT SELECT ON performance_schema.* TO '<YOUR_DB_USERNAME>'@'%';
```
(Opcional) Para visualizar os dados de tempo de espera na plataforma New Relic, é necessário conceder os seguintes privilégios ao usuário de monitoramento:
```
GRANT UPDATE ON performance_schema.setup_consumers TO '<YOUR_DB_USERNAME>'@'%';
```
(Opcional) Para verificar a conexão e as permissões, é necessário executar:
bash
```
$mysql -h <YOUR_DB_HOST> -P <YOUR_DB_PORT> -u <YOUR_DB_USERNAME> -p -e "SELECT 1;"
```
Se o comando for concluído sem erro, o usuário de monitoramento, o host e a porta estarão todos corretos.

Configurar o NRDOT Collector

Configure o NRDOT Collector com suas configurações específicas do MySQL. Selecione o seu tipo de configuração com base nas suas necessidades de monitoramento:

Esta configuração foca no monitoramento essencial do MySQL apenas com o receptor nrmysql.

Crie um arquivo de configuração chamado mysql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/mysql-config.yaml
```

Adicione a seguinte configuração ao arquivo mysql-config.yaml criado na etapa anterior.

receivers:
  nrmysql:
    endpoint: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
    transport: tcp
    username: "<YOUR_DB_USERNAME>"
    password: "<YOUR_DB_PASSWORD>"
    database: "<YOUR_DATABASE_NAME>"
    allow_native_passwords: true
    collection_interval: 10s
    initial_delay: 1s
    tls:
      insecure: false
      insecure_skip_verify: false
      # ca_file: /path/to/global-bundle.pem
    explain_mode: procedure
    statement_events:
      digest_text_limit: 4096
      time_limit: 24h
      limit: 500
    query_sample_collection:
      max_rows_per_query: 100
      allowed_comment_keys: [nr_service_guid]
    top_query_collection:
      lookback_time: 120
      max_query_sample_count: 5000
      top_query_count: 200
      collection_interval: 60s
      query_plan_cache_size: 1000
      query_plan_cache_ttl: 1h
      allowed_comment_keys: [nr_service_guid]
    events:
      db.server.query_sample:
        enabled: true
      db.server.top_query:
        enabled: true

processors:
  batch:
  resource/mysql:
    attributes:
      - key: server.address
        value: "<YOUR_DB_HOST>"
        action: upsert
      - key: server.port
        value: <YOUR_DB_PORT>
        action: upsert

exporters:
  otlp/newrelic:
    endpoint: "<YOUR_NEWRELIC_OTLP_ENDPOINT>"
    headers:
      api-key: "<YOUR_NEWRELIC_LICENSE_KEY>"
    compression: gzip
    retry_on_failure:
      enabled: true
      initial_interval: 5s
      max_interval: 30s
      max_elapsed_time: 300s

service:
  pipelines:
    metrics:
      receivers: [nrmysql]
      processors: [resource/mysql, batch]
      exporters: [otlp/newrelic]
    logs:
      receivers: [nrmysql]
      processors: [resource/mysql, batch]
      exporters: [otlp/newrelic]

Esta configuração adiciona métricas no nível do host (CPU, memória, disco, rede) junto com o monitoramento do banco de dados MySQL.

Crie um arquivo de configuração chamado mysql-config.yaml:
bash
```
$sudo nano /etc/nrdot-collector/mysql-config.yaml
```

Adicione a seguinte configuração ao arquivo mysql-config.yaml criado na etapa anterior.

extensions:
  health_check:

receivers:
  otlp:
    protocols:
      grpc:
      http:

  host_metrics:
    collection_interval: 30s
    scrapers:
      cpu:
        metrics:
          system.cpu.time:
            enabled: false
          system.cpu.utilization:
            enabled: true
      load:
      memory:
        metrics:
          system.memory.utilization:
            enabled: true
      paging:
        metrics:
          system.paging.utilization:
            enabled: false
          system.paging.faults:
            enabled: false
      filesystem:
        metrics:
          system.filesystem.utilization:
            enabled: true
      disk:
        metrics:
          system.disk.merged:
            enabled: false
          system.disk.pending_operations:
            enabled: false
          system.disk.weighted_io_time:
            enabled: false
      network:
        metrics:
          system.network.connections:
            enabled: false
      # Uncomment to enable process metrics, which can be noisy but valuable.
      # processes:
      # process:
      #  metrics:
      #    process.cpu.utilization:
      #      enabled: true
      #    process.cpu.time:
      #      enabled: false

  nrmysql:
    endpoint: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
    transport: tcp
    username: "<YOUR_DB_USERNAME>"
    password: "<YOUR_DB_PASSWORD>"
    database: "<YOUR_DATABASE_NAME>"
    allow_native_passwords: true
    collection_interval: 10s
    initial_delay: 1s
    tls:
      insecure: false
      insecure_skip_verify: false
      # Required for Amazon RDS/Aurora with SSL/TLS enforcement -- see
      # Prerequisites -> Network access -> Amazon RDS / Aurora for MySQL.
      # ca_file: /path/to/global-bundle.pem
    # "procedure" collects EXPLAIN plans for write statements (UPDATE/DELETE/INSERT/REPLACE)
    # without granting DML to the monitoring user, via a SQL SECURITY DEFINER procedure.
    # Falls back to "inline" (default) automatically if the procedure is absent for a schema.
    # Requires one-time setup per schema -- see Prerequisites -> DML query plan collection.
    explain_mode: procedure
    statement_events:
      digest_text_limit: 4096
      time_limit: 24h
      limit: 500
    query_sample_collection:
      max_rows_per_query: 100
      # APM-DB correlation: surfaces the nr_service_guid SQL comment tag (e.g. injected by
      # transaction_tracer.sql_metadata_comments in the Java agent) as db.query.comment_tags /
      # db.query.comment_tags.nr_service_guid. Empty list by default -- nothing is extracted
      # unless the key is explicitly allow-listed here.
      allowed_comment_keys: [nr_service_guid]
    top_query_collection:
      lookback_time: 120
      max_query_sample_count: 5000
      top_query_count: 200
      collection_interval: 60s
      query_plan_cache_size: 1000
      query_plan_cache_ttl: 1h
      allowed_comment_keys: [nr_service_guid]
    events:
      db.server.query_sample:
        enabled: true
      db.server.top_query:
        enabled: true

processors:
  metrics_transform:
    transforms:
      - include: system.cpu.utilization
        action: update
        operations:
          - action: aggregate_labels
            label_set: [state]
            aggregation_type: mean
      - include: system.paging.operations
        action: update
        operations:
          - action: aggregate_labels
            label_set: [direction]
            aggregation_type: sum

  filter/exclude_cpu_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "interrupt"'
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "nice"'
        - 'metric.name == "system.cpu.utilization" and attributes["state"] == "softirq"'

  filter/exclude_memory_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_unreclaimable"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "inactive"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "cached"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "buffered"'
        - 'metric.name == "system.memory.utilization" and attributes["state"] == "slab_reclaimable"'

  filter/exclude_memory_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.memory.usage" and attributes["state"] == "slab_unreclaimable"'
        - 'metric.name == "system.memory.usage" and attributes["state"] == "inactive"'

  filter/exclude_filesystem_utilization:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.utilization" and attributes["type"] == "squashfs"'

  filter/exclude_filesystem_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.usage" and attributes["type"] == "squashfs"'
        - 'metric.name == "system.filesystem.usage" and attributes["state"] == "reserved"'

  filter/exclude_filesystem_inodes_usage:
    metrics:
      datapoint:
        - 'metric.name == "system.filesystem.inodes.usage" and attributes["type"] == "squashfs"'
        - 'metric.name == "system.filesystem.inodes.usage" and attributes["state"] == "reserved"'

  filter/exclude_system_disk:
    metrics:
      datapoint:
        - 'metric.name == "system.disk.operations" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.merged" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.io" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.io_time" and IsMatch(attributes["device"], "^loop.*") == true'
        - 'metric.name == "system.disk.operation_time" and IsMatch(attributes["device"], "^loop.*") == true'

  filter/exclude_network:
    metrics:
      datapoint:
        - 'IsMatch(metric.name, "^system.network.*") == true and attributes["device"] == "lo"'

  attributes/exclude_system_paging:
    include:
      match_type: strict
      metric_names:
        - system.paging.operations
    actions:
      - key: type
        action: delete

  cumulative_to_delta:

  transform:
    trace_statements:
      - context: span
        statements:
          - truncate_all(span.attributes, 4095)
          - truncate_all(resource.attributes, 4095)

  transform/host:
    metric_statements:
      - context: metric
        statements:
          - set(metric.description, "")
          - set(metric.unit, "")

  # Static server.address/server.port, reusing the same <YOUR_DB_HOST>/<YOUR_DB_PORT>
  # values already set on the receiver's own `endpoint` field above -- nrmysqlreceiver
  # itself emits no server.address/server.port, only its own mysql.instance.endpoint
  # (a combined "host:port" string). Applies uniformly to both metrics and logs
  # pipelines since neither depends on how that string is derived.
  resource/mysql:
    attributes:
      - key: server.address
        value: "<YOUR_DB_HOST>"
        action: upsert
      - key: server.port
        value: <YOUR_DB_PORT>
        action: upsert

  batch:

  resource_detection:
    detectors: ["system"]
    system:
      hostname_sources: ["os"]
      resource_attributes:
        host.id:
          enabled: true

  resource_detection/cloud:
    detectors: ["gcp", "ec2", "azure"]
    timeout: 2s
    override: true

  resource_detection/env:
    detectors: ["env"]
    timeout: 2s
    override: true

exporters:
  otlp/newrelic:
    endpoint: "<YOUR_NEWRELIC_OTLP_ENDPOINT>"
    headers:
      api-key: "<YOUR_NEWRELIC_LICENSE_KEY>"
    compression: gzip
    retry_on_failure:
      enabled: true
      initial_interval: 5s
      max_interval: 30s
      max_elapsed_time: 300s

service:
  telemetry:
    metrics:
      level: none

  extensions: [health_check]

  pipelines:
    metrics/host:
      receivers: [host_metrics]
      processors:
        - metrics_transform
        - filter/exclude_cpu_utilization
        - filter/exclude_memory_utilization
        - filter/exclude_memory_usage
        - filter/exclude_filesystem_utilization
        - filter/exclude_filesystem_usage
        - filter/exclude_filesystem_inodes_usage
        - filter/exclude_system_disk
        - filter/exclude_network
        - attributes/exclude_system_paging
        - transform/host
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - cumulative_to_delta
        - batch
      exporters: [otlp/newrelic]

    metrics/mysql:
      receivers: [nrmysql]
      processors:
        - resource/mysql
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - batch
      exporters: [otlp/newrelic]

    logs/mysql:
      receivers: [nrmysql]
      processors:
        - resource/mysql
        - resource_detection
        - resource_detection/cloud
        - resource_detection/env
        - batch
      exporters: [otlp/newrelic]

    traces:
      receivers: [otlp]
      processors: [transform, resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

    metrics:
      receivers: [otlp]
      processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

    logs:
      receivers: [otlp]
      processors: [resource_detection, resource_detection/cloud, resource_detection/env, batch]
      exporters: [otlp/newrelic]

Importante

A integração do MySQL via NRDOT Collector segue o preço de ingestão de dados padrão. Observe que a configuração completa do recurso ingere mais dados do que uma configuração padrão, o que pode aumentar a fatura geral.

Parâmetro de configuração

A tabela a seguir descreve os principais parâmetros de configuração para o receptor nrmysql:

Parâmetro	Descrição
`<YOUR_DB_HOST>`	Insira o nome do host ou endereço IP do MySQL.
`<YOUR_DB_PORT>`	Insira o número da porta do MySQL. O valor padrão é `3306`.
`<YOUR_DB_USERNAME>`	Insira o nome de usuário do usuário de monitoramento criado em Configurar o usuário do banco de dados.
`<YOUR_DB_PASSWORD>`	Insira a senha do usuário de monitoramento criado em Configurar Usuário do Banco de Dados.
`<YOUR_DATABASE_NAME>`	Opcional. Insira um nome de banco de dados específico para restringir o monitoramento a ele. Omita este parâmetro para monitorar todos os bancos de dados que o usuário de monitoramento pode acessar.
`<YOUR_NEWRELIC_OTLP_ENDPOINT>`	Insira o endpoint OTLP da New Relic. Para mais informações, consulte os endpoints OTLP da New Relic.
`<YOUR_NEWRELIC_LICENSE_KEY>`	Insira sua chave de licença do New Relic.
`transport`	O valor padrão está definido como `tcp` para conectar pela rede. Se o seu NRDOT Collector for executado no mesmo host que o MySQL, em vez disso, use `unix` para conectar por meio de um soquete de domínio Unix.
`collection_interval`	Insira o intervalo entre as coletas de métrica. Padrão: `10s`.
`explain_mode`	O valor padrão está definido como `inline`. É necessário definir o valor como `procedure` para coletar planos de consulta para instruções de gravação sem conceder privilégios DML ao usuário de monitoramento. Consultar Planos de consulta para instruções de gravação.

Validar a configuração do NRDOT Collector

Atualize o caminho da configuração para apontar para seu novo arquivo mysql-config.yaml:
bash
```
$OTELCOL_OPTIONS="/etc/nrdot-collector/mysql-config.yaml"
```
Valide a configuração do Collector NRDOT para garantir que esteja formatada corretamente e funcione adequadamente:
bash
```
$sudo /usr/bin/nrdot-collector validate --config=/etc/nrdot-collector/mysql-config.yaml
```

Dica

Você também pode:

Configurar Múltiplos Receptores: para monitorar múltiplas instâncias do MySQL a partir de um coletor.
Vincular o banco de dados MySQL com o APM: para correlacionar o desempenho do aplicativo com as operações do banco de dados. Isso permite visualizar exatamente quais aplicativos estão gerando workloads específicas de banco de dados.
Configurar o SQL Query Receiver: para coletar métricas personalizadas do banco de dados MySQL.
Configurar o gerenciamento de segredos: para gerenciar com segurança informações confidenciais, como credenciais de banco de dados. Isso ajuda a aprimorar a segurança do seu ambiente de monitoramento ao evitar a inserção direta de dados sensíveis nos arquivos de configuração.

Reiniciar o NRDOT Collector

Após atualizar sua configuração, reinicie o serviço NRDOT Collector:

bash

$sudo systemctl restart nrdot-collector

Dica

Sempre reinicie o serviço do coletor NRDOT após fazer alterações na configuração para garantir que as novas configurações entrem em vigor.

Para verificar se o coletor está funcionando corretamente, verifique o status do serviço:

bash

$sudo systemctl status nrdot-collector

Encontre e use seus dados

Assim que os dados estiverem sendo coletados, será possível acessar o monitoramento abrangente do banco de dados MySQL por meio da interface do New Relic.

Para encontrar a entidade de banco de dados MySQL no New Relic:

Vá para https://one.newrelic.com > All Capabilities > Databases.
Na dropdown Entity type, selecione MySQL instance e clique em Apply.
Selecione seu banco de dados MySQL na lista de entidades.
Após configurar o monitoramento de banco de dados MySQL com o NRDOT:
- Crie dashboards personalizados para visualizar suas métricas de banco de dados
- Configure alertas para limites críticos de desempenho do banco de dados

Guia de solução de problemas

Saiba como solucionar problemas comuns com o monitoramento do MySQL.

Referência de métricas

Saiba mais sobre as métricas disponíveis coletadas pelo NRDOT Collector.

Instrumentação em ambientes RDS

Saiba como configurar o monitoramento do MySQL em ambientes RDS com o New Relic.

Esta tradução de máquina é fornecida para sua comodidade.

Instale & configure o NRDOT para MySQL auto-hospedado

Visualização

Pré-requisitos

Configurar o NRDOT Collector

Para arquitetura AMD64

Para arquitetura ARM64

Configurar usuário do banco de dados

Configurar o NRDOT Collector

Configuração padrão

Configuração com todos os recursos

Importante

Parâmetro de configuração

Validar a configuração do NRDOT Collector

Dica

Reiniciar o NRDOT Collector

Dica

Encontre e use seus dados

Guia de solução de problemas

Referência de métricas

Instrumentação em ambientes RDS

Esta tradução de máquina é fornecida para sua comodidade.

Instale & configure o NRDOT para MySQL auto-hospedado

Visualização

Pré-requisitos .css-21sua1{background:none;border:none;width:0;padding:0;}

Configurar o NRDOT Collector

Para arquitetura ARM64

Configurar usuário do banco de dados

Configurar o NRDOT Collector

Configuração padrão

Configuração com todos os recursos

Importante

Parâmetro de configuração

Validar a configuração do NRDOT Collector

Dica

Reiniciar o NRDOT Collector

Dica

Encontre e use seus dados

Documentação relacionada

Guia de solução de problemas

Referência de métricas

Instrumentação em ambientes RDS

Pré-requisitos