Prérequis Paramètres Données d'entrée Données de sortie Exemple d'utilisation Licences Journal des modifications Consultez aussi

Connecteur d'intégration Splunk

Avertissement

Ce connecteur est passé à la phase de durée de vie prolongée et AWS IoT Greengrass ne publiera pas de mises à jour fournissant des fonctionnalités, des améliorations aux fonctionnalités existantes, des correctifs de sécurité ou des corrections de bogues. Pour de plus amples informations, veuillez consulter AWS IoT Greengrass Version 1 politique de maintenance.

Le connecteur d'intégration Splunk publie les données des appareils Greengrass sur Splunk. Cela vous permet d'utiliser Splunk pour surveiller et analyser l'environnement Greengrass Core et d'agir sur les événements locaux. Le connecteur s'intègre avec HTTP Event Collector (HEC). Pour plus d'informations, consultez la section Introduction to HTTP Event Collector dans la documentation Splunk.

Ce connecteur reçoit la journalisation et les données d'événement dans une rubrique MQTT et publie les données en l'état dans l'API Splunk.

Vous pouvez utiliser ce connecteur pour prendre en charge des scénarios professionnels, par exemple :

Les opérateurs peuvent utiliser les données périodiques des actionneurs et des capteurs (par exemple, les relevés de température, de pression et d'eau) pour déclencher des alarmes lorsque les valeurs dépassent certains seuils.
les développeurs utilisent des données collectées à partir de machines industrielles pour créer des modèles de ML qui peuvent surveiller l'équipement pour les problèmes potentiels.

Ce connecteur est disponible dans les versions suivantes.

Version	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`

Pour obtenir des informations sur les changements apportés aux versions, veuillez consulter le Journal des modifications.

Prérequis

Ce connecteur possède les critères suivants :

Version 3 - 4

AWS IoT Greengrass Logiciel de base v1.9.3 ou version ultérieure. AWS IoT Greengrass doit être configuré pour prendre en charge les secrets locaux, comme décrit dans la section Exigences relatives aux secrets.

Note
Cette exigence inclut l'autorisation d'accéder aux secrets de votre Gestionnaire de Secrets. Si vous utilisez le rôle de service Greengrass par défaut, Greengrass est autorisé à obtenir les valeurs des secrets dont le nom commence par greengrass-.
Python version 3.7 ou 3.8 installé sur le périphérique principal et ajouté à la variable d'environnement PATH.
Note
Pour utiliser Python 3.8, exécutez la commande suivante pour créer un lien symbolique entre le dossier d'installation par défaut de Python 3.7 et les fichiers binaires Python 3.8 installés.
```
sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7
```
Ceci configure votre appareil de sorte qu'il réponde aux exigence de Python pour AWS IoT Greengrass.
La fonctionnalité HTTP Event Collector doit être activée dans Splunk. Pour de plus amples informations, veuillez consulter Set up and use HTTP eEvent Collector in Splunk Web dans la documentation Splunk.
Secret de type texte dans AWS Secrets Manager lequel est stocké votre jeton Splunk HTTP Event Collector. Pour plus d'informations, consultez À propos des jetons de collecte d'événements dans la documentation Splunk et Création d'un secret de base dans le guide de l'AWS Secrets Manager utilisateur.

Note
Pour créer le secret dans la console Secrets Manager, entrez votre jeton dans l'onglet Plaintext. N'incluez pas de guillemets ni d'autres mises en forme. Dans l'API, spécifiez le jeton comme valeur de la SecretString propriété.
Une ressource secrète du groupe Greengrass qui fait référence au secret du Secrets Manager. Pour de plus amples informations, veuillez consulter Déployez les secrets jusqu'au AWS IoT Greengrass cœur.

Versions 1 - 2

AWS IoT Greengrass Logiciel de base v1.7 ou version ultérieure. AWS IoT Greengrass doit être configuré pour prendre en charge les secrets locaux, comme décrit dans la section Exigences relatives aux secrets.

Note
Cette exigence inclut l'autorisation d'accéder aux secrets de votre Gestionnaire de Secrets. Si vous utilisez le rôle de service Greengrass par défaut, Greengrass est autorisé à obtenir les valeurs des secrets dont le nom commence par greengrass-.
Python version 2.7 installé sur le périphérique principal et ajouté à la variable d'environnement PATH.
La fonctionnalité HTTP Event Collector doit être activée dans Splunk. Pour de plus amples informations, veuillez consulter Set up and use HTTP eEvent Collector in Splunk Web dans la documentation Splunk.
Secret de type texte dans AWS Secrets Manager lequel est stocké votre jeton Splunk HTTP Event Collector. Pour plus d'informations, consultez À propos des jetons de collecte d'événements dans la documentation Splunk et Création d'un secret de base dans le guide de l'AWS Secrets Manager utilisateur.

Note
Pour créer le secret dans la console Secrets Manager, entrez votre jeton dans l'onglet Plaintext. N'incluez pas de guillemets ni d'autres mises en forme. Dans l'API, spécifiez le jeton comme valeur de la SecretString propriété.
Une ressource secrète du groupe Greengrass qui fait référence au secret du Secrets Manager. Pour de plus amples informations, veuillez consulter Déployez les secrets jusqu'au AWS IoT Greengrass cœur.

Paramètres du connecteur

Ce connecteur fournit les paramètres suivants :

Version 4

SplunkEndpoint

Point de terminaison de votre instance Splunk. Cette valeur doit contenir le protocole, le nom d'hôte et le port.

Nom affiché dans la AWS IoT console : point de terminaison Splunk

Nécessaire : true

Type : string

Schéma valide : ^(http:\/\/|https:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$

MemorySize

Quantité de mémoire (en Ko) allouée au connecteur.

Nom affiché dans la AWS IoT console : Taille de la mémoire

Nécessaire : true

Type : string

Schéma valide : ^[0-9]+$

SplunkQueueSize

Nombre maximal d'éléments à enregistrer dans la mémoire avant que les éléments ne soient envoyés ou supprimés. Lorsque cette limite est atteinte, les éléments les plus anciens de la file d'attente sont remplacés par des éléments plus récents. Cette limite s'applique généralement lorsqu'il n'y a pas de connexion à Internet.

Nom affiché dans la AWS IoT console : nombre maximum d'éléments à conserver

Nécessaire : true

Type : string

Schéma valide : ^[0-9]+$

SplunkFlushIntervalSeconds

Intervalle (en secondes) pour publier les données reçues dans Splunk HEC. La valeur maximale est 900. Pour configurer le connecteur afin qu'il publie les éléments au fur et à mesure qu'elles sont reçues (sans traitement par lot), spécifiez 0.

Nom affiché dans la AWS IoT console : intervalle de publication Splunk

Nécessaire : true

Type : string

Schéma valide : [0-9]|[1-9]\d|[1-9]\d\d|900

SplunkTokenSecretArn

Le secret réside dans AWS Secrets Manager le stockage du jeton Splunk. Il doit s'agir d'un secret de type texte.

Nom affiché dans la AWS IoT console : ARN du code secret du jeton d'authentification Splunk

Nécessaire : true

Type : string

Schéma valide : arn:aws:secretsmanager:[a-z]{2}-[a-z]+-\d{1}:\d{12}?:secret:[a-zA-Z0-9-_]+-[a-zA-Z0-9-_]+

SplunkTokenSecretArn-ResourceId

La ressource de secret dans le groupe Greengrass qui référence le secret Splunk.

Nom affiché dans la AWS IoT console : ressource de jeton d'authentification Splunk

Nécessaire : true

Type : string

Schéma valide : .+

SplunkCustomCALocation

Chemin d'accès au fichier d'autorité de certification (CA) personnalisée pour Splunk (par exemple, /etc/ssl/certs/splunk.crt).

Nom d'affichage dans la AWS IoT console : emplacement de l'autorité de certification personnalisée de Splunk

Nécessaire : false

Type : string

Schéma valide : ^$|/.*

IsolationMode

Mode conteneurisation de ce connecteur. La valeur par défaut estGreengrassContainer, ce qui signifie que le connecteur s'exécute dans un environnement d'exécution isolé à l'intérieur du AWS IoT Greengrass conteneur.

Note

Le paramètre de conteneurisation par défaut pour le groupe ne s'applique pas aux connecteurs.

Nom affiché dans la AWS IoT console : mode d'isolation du conteneur

Nécessaire : false

Type : string

Valeurs valides : GreengrassContainer ou NoContainer

Schéma valide : ^NoContainer$|^GreengrassContainer$

Version 1 - 3

SplunkEndpoint

Point de terminaison de votre instance Splunk. Cette valeur doit contenir le protocole, le nom d'hôte et le port.

Nom affiché dans la AWS IoT console : point de terminaison Splunk

Nécessaire : true

Type : string

Schéma valide : ^(http:\/\/|https:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$

MemorySize

Quantité de mémoire (en Ko) allouée au connecteur.

Nom affiché dans la AWS IoT console : Taille de la mémoire

Nécessaire : true

Type : string

Schéma valide : ^[0-9]+$

SplunkQueueSize

Nom affiché dans la AWS IoT console : nombre maximum d'éléments à conserver

Nécessaire : true

Type : string

Schéma valide : ^[0-9]+$

SplunkFlushIntervalSeconds

Nom affiché dans la AWS IoT console : intervalle de publication Splunk

Nécessaire : true

Type : string

Schéma valide : [0-9]|[1-9]\d|[1-9]\d\d|900

SplunkTokenSecretArn

Le secret réside dans AWS Secrets Manager le stockage du jeton Splunk. Il doit s'agir d'un secret de type texte.

Nom affiché dans la AWS IoT console : ARN du code secret du jeton d'authentification Splunk

Nécessaire : true

Type : string

Schéma valide : arn:aws:secretsmanager:[a-z]{2}-[a-z]+-\d{1}:\d{12}?:secret:[a-zA-Z0-9-_]+-[a-zA-Z0-9-_]+

SplunkTokenSecretArn-ResourceId

La ressource de secret dans le groupe Greengrass qui référence le secret Splunk.

Nom affiché dans la AWS IoT console : ressource de jeton d'authentification Splunk

Nécessaire : true

Type : string

Schéma valide : .+

SplunkCustomCALocation

Chemin d'accès au fichier d'autorité de certification (CA) personnalisée pour Splunk (par exemple, /etc/ssl/certs/splunk.crt).

Nom d'affichage dans la AWS IoT console : emplacement de l'autorité de certification personnalisée de Splunk

Nécessaire : false

Type : string

Schéma valide : ^$|/.*

Exemple de création de connecteur (AWS CLI)

La commande CLI suivante crée un ConnectorDefinition avec une version initiale contenant le connecteur d'intégration 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"
            }
        }
    ]
}'

Note

La fonction Lambda de ce connecteur a un cycle de vie prolongé.

Dans la AWS IoT Greengrass console, vous pouvez ajouter un connecteur depuis la page Connecteurs du groupe. Pour de plus amples informations, veuillez consulter Mise en route avec les connecteurs Greengrass (console).

Données d'entrée

Ce connecteur accepte les données de journalisation et d'événement sur un sujet MQTT et publie les données reçues telles quelles dans l'API Splunk. Les messages d'entrée doivent être au format JSON.

Filtre de rubrique dans l'abonnement

splunk/logs/put

Propriétés des messages

request

Données d'événements à envoyer à l'API Splunk. Les événements doivent répondre aux spécifications de l'API services/collector.

Nécessaire : true

Type :object. Seule la propriété event est obligatoire.

id

ID arbitraire de la demande. Cette propriété est utilisée pour mapper une demande d'entrée à un statut de sortie.

Nécessaire : false

Type : string

Restrictions

Toutes les limites imposées par l'API Splunk s'appliquent lorsque ce connecteur est utilisé. Pour plus d'informations, consultez services/collector.

Exemple d'entrée


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

Données de sortie

Ce connecteur publie des données de sortie dans deux rubriques :

Informations de statut dans la rubrique splunk/logs/put/status.
Erreurs dans la rubrique splunk/logs/put/error.

Filtre de rubriques : splunk/logs/put/status

Utilisez cette rubrique pour écouter le statut des demandes. Chaque fois que le connecteur envoie un lot de données reçues à l'API Splunk, il publie une liste IDs des demandes réussies et échouées.

Exemple de sortie


{
    "response": {
        "succeeded": [
            "request123",
            ...
        ],
        "failed": [
            "request789",
            ...
        ]
    }
}

Filtre de rubriques : splunk/logs/put/error

Utilisez cette rubrique pour écouter les erreurs du connecteur. La propriété error_message qui décrit l'erreur ou l'expiration rencontrée lors du traitement de la demande.

Exemple de sortie


{
    "response": {
        "error": "UnauthorizedException",
        "error_message": "invalid splunk token",
        "status": "fail"
    }
}

Note

Si le connecteur détecte une erreur réessayable (par exemple, des erreurs de connexion), il réessaie de publier dans le lot suivant.

Exemple d'utilisation

Suivez les étapes de haut niveau suivantes pour configurer un exemple de fonction Lambda en Python 3.7 que vous pouvez utiliser pour tester le connecteur.

Note

Si vous utilisez d'autres environnements d'exécution Python, vous pouvez créer un lien symbolique entre Python3.x et Python 3.7.
Les rubriques Démarrer avec les connecteurs (console) et Démarrer avec les connecteurs (CLI) contiennent des étapes détaillées qui vous montrent comment configurer et déployer un exemple de connecteur Twilio Notifications.

Veillez à répondre aux conditions requises pour le connecteur.
Créez et publiez une fonction Lambda qui envoie des données d'entrée au connecteur.

Enregistrez l'exemple de code en tant que fichier PY. Téléchargez et décompressez le SDK AWS IoT Greengrass principal pour Python. Ensuite, créez un package zip contenant le fichier PY et le dossier greengrasssdk au niveau racine. Ce package zip est le package de déploiement vers lequel vous effectuez le téléchargement AWS Lambda.

Après avoir créé la fonction Lambda Python 3.7, publiez une version de la fonction et créez un alias.
Configurez votre groupe Greengrass.
1. Ajoutez la fonction Lambda par son alias (recommandé). Configurez le cycle de vie Lambda comme étant de longue durée (ou dans "Pinned": true la CLI).
2. Ajoutez la ressource secrète requise et accordez un accès en lecture à la fonction Lambda.
3. Ajoutez le connecteur et configurez ses paramètres.
4. Ajoutez des abonnements qui permettent au connecteur de recevoir des données d'entrée et d'envoyer des données de sortie sur des filtres de rubrique pris en charge.
  - Définissez la fonction Lambda comme source, le connecteur comme cible et utilisez un filtre de rubrique d'entrée compatible.
  - Définissez le connecteur en tant que source, AWS IoT Core en tant que cible et utilisez un filtre de rubrique de sortie pris en charge. Vous utilisez cet abonnement pour afficher les messages d'état dans la AWS IoT console.
Déployez le groupe.
Dans la AWS IoT console, sur la page Test, abonnez-vous à la rubrique des données de sortie pour consulter les messages d'état du connecteur. L'exemple de fonction Lambda a une longue durée de vie et commence à envoyer des messages immédiatement après le déploiement du groupe.

Lorsque vous avez terminé les tests, vous pouvez définir le cycle de vie Lambda à la demande (ou "Pinned": false dans la CLI) et déployer le groupe. Cela empêche la fonction d'envoyer des messages.

exemple

L'exemple suivant de fonction Lambda envoie un message d'entrée au connecteur.


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

Licences

Ce connecteur est publié dans le cadre du contrat de licence logicielle Greengrass Core.

Journal des modifications

Le tableau suivant décrit les modifications apportées à chaque version du connecteur.

Version	Modifications
4	Ajout du paramètre `IsolationMode` pour configurer le mode de conteneurisation du connecteur.
3	Mise à niveau de l'environnement d'exécution Lambda vers Python 3.7, ce qui modifie les exigences d'exécution.
2	Correctif pour réduire la journalisation excessive.
1	Première version.

Un groupe Greengrass ne peut contenir qu'une seule version du connecteur à la fois. Pour de plus amples informations sur la mise à niveau d'une version de connecteur, veuillez consulter Mise à niveau des versions du connecteur.

Consultez aussi

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

SNS

Notifications Twilio