Receptor de consulta SQL com NRDOT

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.

O sqlqueryreceiver é um receptor do OpenTelemetry Collector que permite executar qualquer consulta SQL personalizada em seu banco de dados e ingerir os resultados como métricas no New Relic.

Use isso quando quiser monitorar dados não cobertos pelas métricas integradas do nroracledbreceiver / nrsqlserverreceiver. As métricas personalizadas coletadas via sqlqueryreceiver aparecem sob a mesma entidade do Oracle ou SQL Server no New Relic que os dados do receptor integrado, desde que host.name esteja configurado corretamente.

Pré-requisitos

O usuário do banco de dados configurado na fonte de dados deve ter o privilégio SELECT em qualquer visualização ou tabela que você pretenda consultar.
O binário do coletor deve incluir o componente sqlqueryreceiver.

Configuração

Adicione o bloco sqlqueryreceiver dentro da seção receivers: do seu oracle-config.yaml existente, ao lado do bloco nroracledb existente:

receivers:
  nroracledb:

  ...

  sqlquery/oracle:
    driver: oracle

    # Approach 1: Use the `endpoint`, `username`, `password`, and `service` fields to connect to your database. The receiver will construct the datasource URL for you.
    # host: <YOUR_DB_HOST>
    # port: <YOUR_DB_PORT>
    # database: <YOUR_DATABASE_NAME>
    # username: <YOUR_DB_USERNAME>
    # password: <YOUR_DB_PASSWORD>


    # Approach 2: Use the `datasource` field to provide a full connection string. 
    datasource: "oracle://<YOUR_DB_USERNAME>:<YOUR_DB_PASSWORD>@<YOUR_DB_HOST>:<YOUR_DB_PORT>/<YOUR_SERVICE_NAME>"

    collection_interval: 60s
    queries:
      - sql: "<YOUR_CUSTOM_SQL>"
        metrics:
          - metric_name: oracledb.<YOUR_METRIC_NAME>
            value_column: <RESULT_COLUMN>
            attribute_columns: [<DIMENSION_COLUMN_1>, <DIMENSION_COLUMN_2>]
            value_type: double

Defina os seguintes parâmetros para cada métrica:

Parâmetro	Descrição
`<YOUR_DB_HOST>`	Seu nome do host ou endereço IP. Por exemplo, `10.12.0.4`
`<YOUR_DB_PORT>`	O número da sua porta. O valor padrão é definido como `1433`
`<YOUR_DB_USERNAME>`	Seu nome de usuário do banco de dados Oracle. Por exemplo `newrelic`
`<YOUR_DB_PASSWORD>`	A senha do seu banco de dados Oracle.
`<YOUR_SERVICE_NAME>`	O nome do seu serviço Oracle. Por exemplo `master`
`<collection_interval>`	Com que frequência executar as consultas e coletar métricas. Por exemplo, `30s` , `60s`
`<YOUR_CUSTOM_SQL>`	A consulta SQL a ser executada. Importante Certifique-se de que as suas consultas personalizadas não coletem ou exponham PII ou dados confidenciais.
`<YOUR_METRIC_NAME>`	A exibição do nome da sua métrica no New Relic. Use o prefixo `oracledb.` para consistência. Por exemplo `oracledb.custom.wait_time_ms`
`<VALUE_COLUMN>`	A coluna do resultado da consulta cujo valor se torna o valor da métrica. Por exemplo `wait_time_ms`
`<VALUE_TYPE>`	Tipo de dados da coluna de valor. Opções: `int` , `double` . O padrão é `int` se omitido. Por exemplo `int`
`<DATA_TYPE>`	Tipo de métrica OTLP. Use `gauge` para valores atuais/de snapshot. Use `sum` para contadores cumulativos. O padrão é `gauge` se omitido. Por exemplo `gauge`
`<UNIT>`	Unidade de medida do valor da métrica. Usado como metadados no New Relic. Por exemplo `ms` , `By` , `s` , `%` , `1`
`<ATTRIBUTE_COLUMNS>`	Colunas do resultado da consulta que se tornam rótulos/dimensões de métricas. Usado para filtrar e facetar no NRQL. Por exemplo `["wait_type", "database_name"]`

Importante

Para usuários do Oracle CDB (prefixo C##), codifique # como %23 na URL da fonte de dados. Por exemplo: c##newrelic deve ser c%23%23newrelic

Convenção de nomenclatura

Os nomes das métricas devem começar com oracledb. para serem associados à entidade correta no New Relic. Métricas com um prefixo diferente serão ingeridas, mas não aparecerão sob a entidade do banco de dados.

Síntese de entidade

Adicione um processador resource/add_host para definir host.name com o mesmo valor usado pelo receptor do banco de dados. Sem isso, as métricas personalizadas não serão vinculadas à entidade do banco de dados.

Adicione o processador na seção processors::

processors:
  batch:
  resource/add_event_name:
    attributes:
      - key: host.address
        value: "<YOUR_DB_HOST>"
        action: upsert
  resource/add_host:
    attributes:
      - key: host.name
        value: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
        action: upsert

Configuração de Pipeline

Adicione um pipeline metrics/custom na seção service.pipelines: da configuração, junto aos pipelines existentes:

service:
  pipelines:
    metrics/oracledb:
      receivers: [nroracledb]
      processors: [resource/add_event_name, batch]
      exporters: [otlp/newrelic]
    logs/oracledb:
      receivers: [nroracledb]
      processors: [resource/add_event_name, batch]
      exporters: [otlp/newrelic]

    metrics/custom:
      receivers: [sqlquery/oracle]
      processors: [resource/add_host, resource/add_event_name, batch]
      exporters: [otlp/newrelic]

Importante

Adicione resource/add_host antes de batch na lista de processadores.

NRQL para validar dados

Após reiniciar o coletor, execute o seguinte para confirmar se a métrica personalizada está chegando:

SELECT uniques(metricName) FROM Metric
WHERE otel.library.name LIKE '%sqlqueryreceiver%'
AND metricName LIKE 'oracledb.%'
SINCE 1 hour ago

Resolução de problemas [#troubleshooting]

Problema	Causa	Consertar
`ORA-00942: table or view does not exist`	Usuário do banco de dados sem privilégio SELECT	Conceda `SELECT ON <VIEW_NAME>` ao usuário
`missing port in address`	`#` em nome de usuário/senha não codificados em URL	Substitua `#` por `%23` na URL da fonte de dados
Nenhum dado no New Relic	`host.name` não definido ou incompatível	Adicione o processador `resource/add_host` com o valor correto do host
Métrica não sob a entidade de banco de dados	Nome da métrica sem o prefixo obrigatório	Certifique-se de que os nomes das métricas comecem com `oracledb.` para o banco de dados Oracle ou `sqlserver.` para o SQL Server.

Adicione o bloco sqlqueryreceiver dentro da seção receivers: da configuração do coletor do SQL Server, ao lado do bloco nrsqlserver existente:

receivers:
  nrsqlserver:
    ...

  sqlquery:
    driver: sqlserver

    #Approach 1: Use the `host`, `port`, `database`, `username`, and `password` fields to connect to your database. The receiver will construct the datasource URL for you.
    # host: <YOUR_DB_HOST>
    # port: <YOUR_DB_PORT>
    # database: <YOUR_DATABASE_NAME>
    # username: <YOUR_DB_USERNAME>
    # password: <YOUR_DB_PASSWORD>

    # Approach 2: Use the `datasource` field to provide a full connection string.
    datasource: "sqlserver://<YOUR_DB_USERNAME>:<YOUR_DB_PASSWORD>@<YOUR_DB_HOST>:<YOUR_DB_PORT>?database=<YOUR_DATABASE_NAME>"
    collection_interval: 30s
    queries:
      - sql: "<YOUR_CUSTOM_SQL>"
        metrics:
          - metric_name: sqlserver.<YOUR_METRIC_NAME>
            value_column: <VALUE_COLUMN>
            value_type: <VALUE_TYPE>
            data_type: <DATA_TYPE>
            unit: <UNIT>
            attribute_columns: ["<ATTRIBUTE_COLUMNS>"]

      - sql: "<YOUR_CUSTOM_SQL>"
        metrics:
          - metric_name: sqlserver.<YOUR_METRIC_NAME>
            value_column: <VALUE_COLUMN>
            value_type: <VALUE_TYPE>
            data_type: <DATA_TYPE>
            unit: <UNIT>
            attribute_columns: ["<ATTRIBUTE_COLUMNS>"]

Defina os seguintes parâmetros para cada métrica:

Parâmetro	Descrição
`<YOUR_DB_HOST>`	Nome do host ou endereço IP do seu servidor. Por exemplo, `10.12.0.4`
`<YOUR_DB_PORT>`	O número da porta do seu servidor. O valor padrão é definido como `1433`
`<YOUR_DB_USERNAME>`	Seu nome de usuário do SQL Server. Omita para autenticação de domínio do Windows/GMSA. Por exemplo `newrelic`
`<YOUR_DB_PASSWORD>`	Sua senha do SQL Server. Omita para autenticação de domínio do Windows/GMSA. Por exemplo `secret`
`<YOUR_DATABASE_NAME>`	O nome do seu banco de dados para usar como contexto de conexão inicial. Por exemplo `master`
`collection_interval`	Com que frequência executar as consultas e coletar métricas. Por exemplo, `30s` , `60s`
`<YOUR_CUSTOM_SQL>`	A consulta SQL a ser executada. Por exemplo, `SELECT SUM(pages_kb) / 1024 AS size_mb, type FROM sys.dm_os_memory_clerks GROUP BY type` Importante Certifique-se de que as suas consultas personalizadas não coletem ou exponham PII ou dados confidenciais.
`<YOUR_METRIC_NAME>`	A exibição do nome da sua métrica no New Relic. Use o prefixo `sqlserver.` para consistência. Por exemplo `sqlserver.custom.wait_time_ms`
`<VALUE_COLUMN>`	A coluna do resultado da consulta cujo valor se torna o valor da métrica. Por exemplo `wait_time_ms`
`<VALUE_TYPE>`	Tipo de dados da coluna de valor. Opções: `int` , `double` . O padrão é `int` se omitido. Por exemplo `int`
`<DATA_TYPE>`	Tipo de métrica OTLP. Use `gauge` para valores atuais/de snapshot. Use `sum` para contadores cumulativos. O padrão é `gauge` se omitido. Por exemplo `gauge`
`<UNIT>`	Unidade de medida do valor da métrica. Usado como metadados no New Relic. Por exemplo `ms` , `By` , `s` , `%` , `1`
`<ATTRIBUTE_COLUMNS>`	Colunas do resultado da consulta que se tornam rótulos/dimensões de métricas. Usado para filtrar e facetar no NRQL. Por exemplo `["wait_type", "database_name"]`

Convenção de nomenclatura

Os nomes das métricas devem começar com sqlserver. para serem associados à entidade correta no New Relic. Métricas com um prefixo diferente serão ingeridas, mas não aparecerão sob a entidade do banco de dados.

Síntese de entidade

Adicione o processador na seção processors::

processors:
  resource/add_host:
    attributes:
      - key: service.instance.id
        value: "<YOUR_DB_HOST>:<YOUR_DB_PORT>"
        action: upsert

Configuração de Pipeline

Adicione um pipeline metrics/custom na seção service.pipelines: da configuração, junto aos pipelines existentes:

service:
  pipelines:
    metrics/sqlquery:
      receivers: [sqlquery]
      processors: [resource/add_host, batch]
      exporters: [otlphttp]

Importante

Adicione resource/add_host antes de batch na lista de processadores.

NRQL para validar dados

Após reiniciar o coletor, execute o seguinte para confirmar se a métrica personalizada está chegando:

SELECT uniques(metricName) FROM Metric
WHERE otel.library.name LIKE '%sqlqueryreceiver%'
AND metricName LIKE 'sqlserver.%'
SINCE 1 hour ago

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

Visualização

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

Configuração

Importante

Importante

Convenção de nomenclatura

Síntese de entidade

Configuração de Pipeline

Importante

NRQL para validar dados

Resolução de problemas [#troubleshooting]

Importante

Convenção de nomenclatura

Síntese de entidade

Configuração de Pipeline

Importante

NRQL para validar dados

Pré-requisitos