Documentation sur Oracle Cloud Infrastructure

Charger les journaux d'événements à l'aide de l'API LogEvents

Si vous voulez pousser vos journaux d'événements vers le point d'extrémité Oracle Log Analytics au moyen de l'API LogEvents, suivez les étapes présentées ci-dessous.

  • Vous pouvez charger un ou plusieurs événements à l'aide du format de données utiles prédéfini qui est dans JSON. En outre, l'API prend en charge les formats d'archive GZIP et ZIP

  • La taille maximale autorisée de chaque fichier JSON est de 2 Mo. Toutefois, une demande de chargement peut contenir plusieurs fichiers JSON jusqu'à un maximum de 100 sous forme de fichier ZIP.

  • Le groupe de journaux est un paramètre de demande obligatoire qui sera appliqué à la portée de la demande. Le jeu de journaux est un paramètre facultatif et peut être nécessaire pour de grands jeux de données de journal, par exemple, des To de données sur une base quotidienne.

Pour les étapes de chargement de fichiers journaux bruts à l'aide de l'API REST, voir Charger les journaux sur demande.

Préalables :

Avant de commencer à charger vos journaux d'événements, assurez-vous de collecter les informations suivantes

Rubriques :

Autoriser les utilisateurs à charger les journaux d'événements

Vous pouvez permettre aux utilisateurs d'effectuer une opération de chargement en accordant sélectivement uniquement les autorisations requises pour effectuer la tâche de chargement, en accordant des autorisations de type de ressource individuel ou en accordant des autorisations de niveau agrégé plus large. Vous pouvez donc sélectionner l'un des trois jeux d'énoncés de politique suivants, selon votre cas.

L'énoncé de politique IAM suivant permet de fournir les autorisations spécifiques au groupe d'utilisateurs pour le chargement :

allow group <group_name> to {LOG_ANALYTICS_LOG_GROUP_UPLOAD_LOGS} in compartment <log_group_compartment>

L'énoncé de politique IAM suivant permet de fournir des autorisations au niveau des types de ressource individuels pour le chargement :

allow group <group_name> to use loganalytics-log-group in compartment <log_group_compartment>

D'autre part, l'énoncé de politique IAM suivant permet de fournir des autorisations au niveau des ressources agrégées Oracle Log Analytics pour le chargement : 

allow group <group_name> to use loganalytics-resources-family in tenancy/compartment

group_name dans tous les énoncés de politique ci-dessus fait référence au groupe d'utilisateurs auquel les autorisations requises doivent être accordées.

API de chargement des journaux d'événements

Pour plus d'informations sur l'utilisation de l'API REST et sur les demandes de signature, voir API REST et Données d'identification de sécurité.

Pour la documentation sur l'API uploadLogEventsFile, voir API Log Analytics - uploadLogEventsFile.

Pour effectuer un chargement à l'aide de l'API REST, exécutez la commande suivante sur votre hôte :

oci log-analytics upload upload-log-events-file --file <Json_Event_File_Path> --log-group-id <Log_Group_OCID> --namespace-name <Tenancy_Namespace_Name> --payload-type <Payload_Type>

Dans la commande curl ci-dessus,

  • Json_Event_File_Path : Chemin du fichier d'événement JSON. Pour plus de détails sur le format du fichier d'événements JSON et un exemple, voir Format de fichier d'événement à charger à l'aide de l'API LogEvents.

  • Tenancy_Namespace_Name : Espace de noms Oracle Log Analytics utilisé pour la demande.

  • Log_Group_OCID : OCID du groupe de journaux où les journaux chargés sont stockés dans Oracle Log Analytics.

  • Payload_Type : Par défaut, JSON est utilisé. Les valeurs autorisées sont JSON, GZIP, ZIP.

  • Log_Set : Jeu de journaux qui est associé aux journaux chargés. Ce paramètre est facultatif.

Format de fichier d'événement à charger à l'aide de l'API LogEvents

Voici le format type des données utiles JSON :

{
    "metadata":{ ----------------------------------------> Global (file level) metadata section to send additional metadata in field value pair format. The fields should be valid Log Analytics Fields
        "Field1":"Value1",
        "Field2":"Value2",
        "FieldN":"ValueN"
    },
    "logEvents":
    [ ---------------------------------------------------> Group the events (logRecords) that belong to the same logSourceName, entityId, logPath and metadata
        {
            "metadata":{ --------------------------------> Group level metadata section
                "FieldA”:”ValueA”,
                "FieldB”:”ValueB”,
                "FieldN":"ValueN"
            },
            "entityId”:”<EntityOCID>“, -------------------> Log Analytics Entity OCID
            "logSourceName”:”<LogSourceName>”, -----------> Log Analytics LogSource Name (Mandatory)
            "logPath”:”<LogPath>”, -----------------------> logPath or logFileName to associate the log records with.
            "logRecords": -------------------------------> Array of logRecords/logEntries (Mandatory)
            [
                "logRecord1", ---------------------------> String representation of logRecord. In case the logRecord is of JSON type, it has to be encoded.
                "logRecord2",
                "logRecordN"
            ]
        },
        {            …            …            …       }
    ]
}
Note

La section des métadonnées sert à enrichir les journaux avec les informations qui ne font pas partie des enregistrements de journal réels.

Voici un exemple de données utiles JSON :

{
    "metadata":{
        "Error ID":"0",
        "Environment":"dev",
        "Client Host Region":"IST"
    },
    "logEvents":
    [
        {
            "metadata":{
                "Error ID":"1",
                "Environment":"prod",
                "Client Host Region":"PST"
            },
            "entityId":"ocid1.loganalyticsentity.oc1.iad.amaaaaa...........",
            "logSourceName":"Linux Syslog Logs",
            "logPath":"/var/log/messages",
            "logRecords":
            [
                “Oct 20 2023 04:02:37 hostA syslogd 1.4.1: restart.",
                “Oct 20 2023 04:02:38 hostB syslogd 1.4.1: shutdown."
            ]
        }
    ]
}