Conector de integração Splunk - AWS IoT Greengrass
RequisitosParâmetrosDados de entradaDados de saídaExemplo de usoLicençasChangelogConsulte também

AWS IoT Greengrass Version 1 entrou na fase de vida útil prolongada em 30 de junho de 2023. Para obter mais informações, consulte política de manutenção do AWS IoT Greengrass V1. Após essa data, AWS IoT Greengrass V1 não lançaremos atualizações que forneçam recursos, aprimoramentos, correções de erros ou patches de segurança. Os dispositivos que funcionam AWS IoT Greengrass V1 não serão interrompidos e continuarão operando e se conectando à nuvem. É altamente recomendável que você migre para AWS IoT Greengrass Version 2, o que adiciona novos recursos significativos e suporte para plataformas adicionais.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Conector de integração Splunk

Atenção

Esse conector passou para a fase de vida útil estendida e AWS IoT Greengrass não lançará atualizações que forneçam atributos, aprimoramentos para atributos existentes, patches de segurança ou correções de erros. Para obter mais informações, consulte Política de manutenção do AWS IoT Greengrass Version 1.

O conector de integração Splunk publica dados de Dispositivos Greengrass no Splunk. Isso permite que você use o Splunk para monitorar e analisar o ambiente do núcleo do Greengrass e atue em eventos locais. O conector integra-se ao Coletor de eventos HTTP (HEC). Para obter mais informações, consulte Introdução ao Coletor de eventos HTTP do Splunk na documentação do Splunk.

Esse conector recebe o registro em log e os dados de eventos em um tópico MQTT e publica os dados da maneira que se encontram na API do Splunk.

Você pode usar esse conector para oferecer suporte a cenários industriais, como:

  • Os operadores podem usar dados periódicos de sensores e acionadores (por exemplo, temperatura, pressão e leituras de água) para iniciar alarmes quando os valores excederem determinados limites.

  • Os desenvolvedores usam dados coletados de máquinas industriais para criar modelos de ML que podem monitorar o equipamento em relação a possíveis problemas.

Esse conector tem as seguintes versões.

Versão

ARN

4

arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/4

3

arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/3

2

arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/2

1

arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/1

Para obter informações sobre alterações de versão, consulte o Changelog.

Requisitos

Esse conector tem os seguintes requisitos:

Version 3 - 4

  • Software AWS IoT Greengrass Core v1.9.3 ou posterior. O AWS IoT Greengrass deve ser configurado para oferecer suporte a segredos locais, conforme descrito em Requisitos de segredos.

    nota

    Este requisito inclui permitir o acesso aos seus segredos do Secrets Manager. Se você estiver usando o perfil de serviço padrão do Greengrass, o Greengrass terá permissão para obter valores de segredos com nomes que começam com greengrass-.

  • Python, versão 3.7 ou 3.8, instalado no dispositivo de núcleo e adicionado à variável de ambiente PATH.

    nota

    Para usar o Python 3.8, execute o comando a seguir para criar um symblink da pasta de instalação padrão do Python 3.7 para os binários instalados do Python 3.8.

    sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7

    Isso configura seu dispositivo para atender ao requisito Python para AWS IoT Greengrass.

  • A funcionalidade do Coletor de eventos HTTP deve ser habilitada no Splunk. Para obter mais informações, consulte Configurar e usar o eEvent Collector HTTP no Splunk Web na documentação do Splunk.

  • Um segredo de tipo de texto no AWS Secrets Manager que armazena o token do Coletor de eventos HTTP do Splunk. Para obter mais informações, consulte Sobre os tokens do coletor de eventos na documentação do Splunk e Criando um segredo básico no Guia do usuário do AWS Secrets Manager.

    nota

    Para criar o segredo no console do Secrets Manager, insira seu token na guia Texto simples. Não inclua aspas ou outra formatação. Na API, especifique o token como o valor da propriedade SecretString.

  • Um recurso de segredo no grupo do Greengrass que faz referência ao segredo do Secrets Manager. Para obter mais informações, consulte Implantar segredos no núcleo do AWS IoT Greengrass.

Versions 1 - 2

  • Software AWS IoT Greengrass Core v1.7 ou posterior. O AWS IoT Greengrass deve ser configurado para oferecer suporte a segredos locais, conforme descrito em Requisitos de segredos.

    nota

    Este requisito inclui permitir o acesso aos seus segredos do Secrets Manager. Se você estiver usando o perfil de serviço padrão do Greengrass, o Greengrass terá permissão para obter valores de segredos com nomes que começam com greengrass-.

  • Python versão 2.7 instalado no dispositivo de núcleo e adicionado à variável de ambiente PATH.

  • A funcionalidade do Coletor de eventos HTTP deve ser habilitada no Splunk. Para obter mais informações, consulte Configurar e usar o eEvent Collector HTTP no Splunk Web na documentação do Splunk.

  • Um segredo de tipo de texto no AWS Secrets Manager que armazena o token do Coletor de eventos HTTP do Splunk. Para obter mais informações, consulte Sobre os tokens do coletor de eventos na documentação do Splunk e Criando um segredo básico no Guia do usuário do AWS Secrets Manager.

    nota

    Para criar o segredo no console do Secrets Manager, insira seu token na guia Texto simples. Não inclua aspas ou outra formatação. Na API, especifique o token como o valor da propriedade SecretString.

  • Um recurso de segredo no grupo do Greengrass que faz referência ao segredo do Secrets Manager. Para obter mais informações, consulte Implantar segredos no núcleo do AWS IoT Greengrass.

Parâmetros do conector

Esse conector oferece os seguintes parâmetros:

Version 4
SplunkEndpoint

Um endpoint da sua instância do Splunk. Esse valor deve conter o protocolo, o nome do host e a porta.

Nome de exibição no console do AWS IoT: Endpoint do Splunk

Obrigatório: true

Digite: string

Padrão válido: ^(http:\/\/|https:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$

MemorySize

A quantidade de memória (em KB) a ser alocada para o conector.

Nome de exibição no console do AWS IoT: Tamanho da memória

Obrigatório: true

Digite: string

Padrão válido: ^[0-9]+$

SplunkQueueSize

O número máximo de itens a serem salvos na memória antes de serem enviados ou descartados. Quando esse limite for atingido, os itens mais antigos na fila serão substituídos pelos itens mais recentes. Esse limite normalmente se aplica quando não há conexão com a Internet.

Nome de exibição no console do AWS IoT: Máximo de itens a serem retidos

Obrigatório: true

Digite: string

Padrão válido: ^[0-9]+$

SplunkFlushIntervalSeconds

O intervalo (em segundos) para a publicação de dados recebidos no HEC do Splunk. O valor máximo é 900. Para configurar o conector a fim de publicar itens conforme são recebidos (sem agrupamento em lotes), especifique 0.

Nome de exibição no console do AWS IoT: Intervalo de publicação do Splunk

Obrigatório: true

Digite: string

Padrão válido: [0-9]|[1-9]\d|[1-9]\d\d|900

SplunkTokenSecretArn

O segredo no AWS Secrets Manager que armazena o token do Splunk. Ele deve ser um segredo de tipo de texto.

Nome de exibição no console do AWS IoT: ARN do segredo do token de autenticação do Splunk

Obrigatório: true

Digite: string

Padrão válido: arn:aws:secretsmanager:[a-z]{2}-[a-z]+-\d{1}:\d{12}?:secret:[a-zA-Z0-9-_]+-[a-zA-Z0-9-_]+

SplunkTokenSecretArn-ResourceId

O recurso de segredo no grupo do Greengrass que faz referência ao segredo do Splunk.

Nome de exibição no console do AWS IoT: Recurso do token de autenticação do Splunk

Obrigatório: true

Digite: string

Padrão válido: .+

SplunkCustomCALocation

O caminho do arquivo da autoridade de certificação (CA) personalizada para o Splunk (por exemplo, /etc/ssl/certs/splunk.crt).

Nome de exibição no console do AWS IoT: Localização da autoridade de certificação personalizada do Splunk

Obrigatório: false

Digite: string

Padrão válido: ^$|/.*

IsolationMode

O modo de conteinerização para este conector. O padrão é GreengrassContainer, o que significa que o conector é executado em um ambiente de tempo de execução isolado dentro do contêiner do AWS IoT Greengrass.

nota

A configuração padrão de conteinerização para o grupo não se aplica aos conectores.

Nome de exibição no console do AWS IoT: Modo de isolamento de contêiner

Obrigatório: false

Digite: string

Valores válidos: GreengrassContainer ou NoContainer

Padrão válido: ^NoContainer$|^GreengrassContainer$

Version 1 - 3
SplunkEndpoint

Um endpoint da sua instância do Splunk. Esse valor deve conter o protocolo, o nome do host e a porta.

Nome de exibição no console do AWS IoT: Endpoint do Splunk

Obrigatório: true

Digite: string

Padrão válido: ^(http:\/\/|https:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$

MemorySize

A quantidade de memória (em KB) a ser alocada para o conector.

Nome de exibição no console do AWS IoT: Tamanho da memória

Obrigatório: true

Digite: string

Padrão válido: ^[0-9]+$

SplunkQueueSize

O número máximo de itens a serem salvos na memória antes de serem enviados ou descartados. Quando esse limite for atingido, os itens mais antigos na fila serão substituídos pelos itens mais recentes. Esse limite normalmente se aplica quando não há conexão com a Internet.

Nome de exibição no console do AWS IoT: Máximo de itens a serem retidos

Obrigatório: true

Digite: string

Padrão válido: ^[0-9]+$

SplunkFlushIntervalSeconds

O intervalo (em segundos) para a publicação de dados recebidos no HEC do Splunk. O valor máximo é 900. Para configurar o conector a fim de publicar itens conforme são recebidos (sem agrupamento em lotes), especifique 0.

Nome de exibição no console do AWS IoT: Intervalo de publicação do Splunk

Obrigatório: true

Digite: string

Padrão válido: [0-9]|[1-9]\d|[1-9]\d\d|900

SplunkTokenSecretArn

O segredo no AWS Secrets Manager que armazena o token do Splunk. Ele deve ser um segredo de tipo de texto.

Nome de exibição no console do AWS IoT: ARN do segredo do token de autenticação do Splunk

Obrigatório: true

Digite: string

Padrão válido: arn:aws:secretsmanager:[a-z]{2}-[a-z]+-\d{1}:\d{12}?:secret:[a-zA-Z0-9-_]+-[a-zA-Z0-9-_]+

SplunkTokenSecretArn-ResourceId

O recurso de segredo no grupo do Greengrass que faz referência ao segredo do Splunk.

Nome de exibição no console do AWS IoT: Recurso do token de autenticação do Splunk

Obrigatório: true

Digite: string

Padrão válido: .+

SplunkCustomCALocation

O caminho do arquivo da autoridade de certificação (CA) personalizada para o Splunk (por exemplo, /etc/ssl/certs/splunk.crt).

Nome de exibição no console do AWS IoT: Localização da autoridade de certificação personalizada do Splunk

Obrigatório: false

Digite: string

Padrão válido: ^$|/.*

Exemplo de criação de conector (AWS CLI)

O seguinte comando da CLI cria um ConnectorDefinition com uma versão inicial que contém o conector de integração Splunk.

aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{
    "Connectors": [
        {
            "Id": "MySplunkIntegrationConnector",
            "ConnectorArn": "arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/4",
            "Parameters": {
                "SplunkEndpoint": "https://myinstance.cloud.splunk.com:8088",
                "MemorySize": 200000,
                "SplunkQueueSize": 10000,
                "SplunkFlushIntervalSeconds": 5,
                "SplunkTokenSecretArn":"arn:aws:secretsmanager:region:account-id:secret:greengrass-secret-hash",
                "SplunkTokenSecretArn-ResourceId": "MySplunkResource", 
                "IsolationMode" : "GreengrassContainer"
            }
        }
    ]
}'
nota

A função do Lambda nesse conector tem um ciclo de vida longo.

No console do AWS IoT Greengrass, você pode adicionar um conector na página Conectores do grupo. Para obter mais informações, consulte Conceitos básicos de conectores do Greengrass (console).

Dados de entrada

Esse conector aceita o registro em log e os dados de eventos em um tópico MQTT e publica os dados recebidos da maneira que se encontram na API do Splunk. As mensagens de entrada devem estar no formato JSON.

Filtro de tópico na assinatura

splunk/logs/put

Propriedades de mensagens
request

Os dados de eventos a serem enviados para a API do Splunk. Os eventos devem atender às especificações da API dos serviços/coletor.

Obrigatório: true

Tipo:object. Somente a propriedade event é obrigatória.

id

Um ID arbitrário para a solicitação. Essa propriedade é usada para mapear a solicitação de entrada para um status de saída.

Obrigatório: false

Digite: string

Limites

Todos os limites impostos pela API do Splunk se aplicam ao usar esse conector. Para obter mais informações, consulte serviços/coletor.

Exemplo de entrada
{
    "request": {
        "event": "some event",
        "fields": {
            "severity": "INFO",
            "category": [
                "value1",
                "value2"
            ]
        }
    },
    "id": "request123"
}

Dados de saída

Esse conector publica dados de saída em dois tópicos:

  • Informações de status no tópico splunk/logs/put/status.

  • Erros no tópico splunk/logs/put/error.

Filtro de tópico: splunk/logs/put/status

Use esse tópico para monitorar o status das solicitações. Sempre que o conector envia um lote de dados recebidos para a API do Splunk, ele publica uma lista dos IDs das solicitações que foram bem-sucedidas e que falharam.

Exemplo de saída
{
    "response": {
        "succeeded": [
            "request123",
            ...
        ],
        "failed": [
            "request789",
            ...
        ]
    }
}
Filtro de tópico: splunk/logs/put/error

Use esse tópico para monitorar erros do conector. A propriedade error_message que descreve o erro ou tempo limite encontrado ao processar a solicitação.

Exemplo de saída
{
    "response": {
        "error": "UnauthorizedException",
        "error_message": "invalid splunk token",
        "status": "fail"
    }
}
nota

Se o conector detectar um erro que pode ser repetido (por exemplo, erros de conexão), ele tentará publicar novamente no próximo lote.

Exemplo de uso

Use as seguintes etapas de alto nível para configurar um exemplo de função do Lambda Python 3.7 que pode ser usado para testar o conector.

nota

  1. Certifique-se de cumprir os requisitos para o conector.

  2. Crie e publique uma função do Lambda que envie dados de entrada para o conector.

    Salve o código de exemplo como arquivo PY. Baixe e descompacte o SDK do AWS IoT Greengrass Core para Python. Crie então um pacote zip que contenha o arquivo PY e a pasta greengrasssdk no nível raiz. Este pacote zip é o pacote de implantação que você transfere por upload para o AWS Lambda.

    Depois de criar a função do Lambda Python 3.7, publique uma versão de função e crie um alias.

  3. Configure o grupo do Greengrass.

    1. Adicione a função do Lambda pelo seu alias (recomendado). Configure o ciclo de vida do Lambda como de longa duração (ou "Pinned": true na CLI).

    2. Adicione o recurso de segredode segredo necessário e conceda acesso de leitura à função do Lambda.

    3. Adicione o conector e configure seus parâmetros.

    4. Adicione assinaturas que permitam que o conector receba dados de entrada e envie dados de saída em filtros de tópico compatíveis.

      • Defina a função do Lambda como origem, o conector como destino e use um filtro de tópico de entrada compatível.

      • Defina o conector como origem, o AWS IoT Core como destino, e use um filtro de tópico de saída compatível. Use essa assinatura para exibir mensagens de status no console do AWS IoT.

  4. Implante o grupo.

  5. No console do AWS IoT, na página Teste, assine o tópico de dados de saída para exibir mensagens de status do conector. A função de exemplo do Lambda é de longa duração e começa a enviar mensagens imediatamente após o grupo ser implantado.

    Ao finalizar o teste, você pode definir o ciclo de vida do Lambda como sob demanda (ou "Pinned": false na CLI) e implantar o grupo. Isso impede o envio de mensagens pela função.

Exemplo

O exemplo a seguir da função do Lambda envia uma mensagem de entrada para o conector.

import greengrasssdk
import time
import json

iot_client = greengrasssdk.client('iot-data')
send_topic = 'splunk/logs/put'

def create_request_with_all_fields():
    return {
        "request": {
            "event": "Access log test message."
        },
        "id" : "req_123"
    }

def publish_basic_message():
    messageToPublish = create_request_with_all_fields()
    print("Message To Publish: ", messageToPublish)
    iot_client.publish(topic=send_topic,
        payload=json.dumps(messageToPublish))

publish_basic_message()

def lambda_handler(event, context):
    return

Licenças

Esse conector é liberado de acordo com o Contrato de licença de software do Greengrass Core.

Changelog

A tabela a seguir descreve as alterações em cada versão do conector.

Versão

Alterações

4

Adicionado o parâmetro IsolationMode para configurar o modo de conteinerização para o conector.

3

Atualização do runtime do Lambda para Python 3.7, o que altera o requisito de runtime.

2

Corrija para reduzir o registro excessivo.

1

Versão inicial.

Um grupo do Greengrass só pode conter uma versão do conector por vez. Para obter informações sobre como fazer upgrade de uma versão do conector, consulte Atualizar a versões do conector.

Consulte também