REST Resource: projects.locations.investigations

Ressource : Investigation

Message décrivant l'objet Investigation. Prochain ID : 24

Représentation JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "revision": string,
  "revisionIndex": integer,
  "revisionPredecessor": string,
  "annotations": {
    object (InvestigationAnnotations)
  },
  "executionState": enum (InvestigationExecutionState),
  "error": {
    object (Status)
  },
  "operation": string,
  "title": string,
  "observations": {
    string: {
      object (Observation)
    },
    ...
  },
  "observerStatuses": {
    string: {
      object (ObserverStatus)
    },
    ...
  },
  "clarificationsNeeded": {
    string: {
      object (ClarificationNeeded)
    },
    ...
  }
}
Champs
name

string

Identifiant, nom de la ressource
createTime

string (Timestamp format)

Uniquement en sortie. [Sortie uniquement] Code temporel de création

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. [Sortie uniquement] Code temporel de mise à jour

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Facultatif. Étiquettes sous forme de paires clé/valeur

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
revision

string

Uniquement en sortie. [Sortie uniquement] Révision actuelle de l'investigation
revisionIndex

integer

Uniquement en sortie. [Sortie uniquement] Index de la révision actuelle de l'investigation. Index en base 1.
revisionPredecessor

string

Facultatif. Nom de la révision qui a précédé celle-ci. Par exemple, l'interface utilisateur (UI) définit cette valeur sur la révision existante lorsqu'une nouvelle révision est créée à la suite d'une modification.
annotations

object (InvestigationAnnotations)

Facultatif. Annotations sur l'investigation. Contrairement aux étiquettes, elles peuvent avoir une signification sémantique lors de l'exécution de l'investigation et ne seront pas lues par d'autres systèmes tels que le système de facturation.
executionState

enum (InvestigationExecutionState)

Uniquement en sortie. [Sortie uniquement] État d'exécution de cette investigation.
error

object (Status)

Uniquement en sortie. [Sortie uniquement] Si l'état d'exécution de l'investigation est "FAILED", ce champ contient le message d'erreur associé.
operation

string

Uniquement en sortie. Opération d'exécution la plus récente effectuée sur l'investigation.
title

string

Obligatoire. Titre de l'investigation lisible par l'humain.
observations

map (key: string, value: object (Observation))

Facultatif. Mappage de l'ID d'observation à l'observation. Il s'agit d'un mappage qui permet d'écraser proprement les anciennes observations avec celle de la dernière révision. Consultez la section "Observation" pour obtenir des conseils sur le choix des ID.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
observerStatuses

map (key: string, value: object (ObserverStatus))

Facultatif. Version plurielle de ce qui précède. Le code évoluera progressivement vers cette valeur dans le temps.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
clarificationsNeeded

map (key: string, value: object (ClarificationNeeded))

Facultatif. Questions que le système doit poser à l'utilisateur. L'UI renverra les résultats sous forme de nouvelles observations. L'ID de ces observations sera la clé pour l'entrée dans le mappage clarificationsNeeded.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

InvestigationAnnotations

Annotations supplémentaires définies par l'utilisateur sur une investigation. Des annotations prédéfinies sont disponibles, accompagnées d'un mappage permettant aux nouvelles applications d'y ajouter les leurs.

Représentation JSON 
{
  "followUp": boolean,
  "extrasMap": {
    string: string,
    ...
  },
  "revisionLastRunInterval": {
    object (Interval)
  }
}
Champs
followUp

boolean

Uniquement en sortie. Un suivi est nécessaire pour poursuivre l'investigation. Généralement, cette valeur est définie sur "true" par l'outil de dépannage. Une fois que les questions ont été traitées, elle est définie sur "false".
extrasMap

map (key: string, value: string)

Facultatif. Annotations supplémentaires requises par les applications. Elles ne sont pas masquées et ne doivent PAS contenir d'informations permettant d'identifier personnellement l'utilisateur ou d'informations d'identification de carte de crédit.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
revisionLastRunInterval

object (Interval)

Facultatif. Heure de début/fin de la dernière exécution de la révision.

Interval

Représente un intervalle de temps, encodé sous la forme d'un code temporel de début (inclusif) et d'un code temporel de fin (exclusif).

La valeur de début doit être inférieure ou égale à celle de fin. Lorsque la valeur de début est la même que la valeur de fin, l'intervalle est vide (il ne correspond à aucune durée). Lorsque les heures de début et de fin ne sont pas spécifiées, l'intervalle couvre toutes les heures.

Représentation JSON 
{
  "startTime": string,
  "endTime": string
}
Champs
startTime

string (Timestamp format)

Facultatif. Valeur de début (inclusive) de l'intervalle.

Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être égal ou postérieur à l'heure de début.

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Facultatif. Valeur de fin (exclusive) de l'intervalle.

Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être antérieur à l'heure de fin.

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

InvestigationExecutionState

État d'exécution d'une investigation.

Énumérations
INVESTIGATION_EXECUTION_STATE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
INVESTIGATION_EXECUTION_STATE_RUNNING L'investigation est en cours d'exécution.
INVESTIGATION_EXECUTION_STATE_MODIFIED L'investigation n'a pas encore été exécutée depuis la dernière mise à jour du problème constaté.
INVESTIGATION_EXECUTION_STATE_FAILED L'exécution de l'investigation est terminée, mais elle a échoué.
INVESTIGATION_EXECUTION_STATE_COMPLETED Toutes les tâches d'exécution sont terminées, et l'investigation est au repos.

Observation

Une observation constitue l'unité de base d'échange, que ce soit entre un utilisateur et un système, ou entre différents composants du système. C'est l'élément porteur de pertinence. Par conséquent, les observations doivent rester relativement petites. Si vous prévoyez que les utilisateurs interagiront avec une partie seulement d'une observation, celle-ci doit être décomposée en observations plus petites. Par exemple, une exécution spécifique d'un runbook, une entrée particulière de paramètre utilisateur ou une entrée de journal intéressante peuvent chacune constituer une observation distincte. Cela signifie qu'une investigation peut contenir des dizaines, voire des centaines d'observations. ID suivant : 26.

Représentation JSON 
{
  "id": string,"timeIntervals": [
    {
      object (Interval)
    }
  ],
  "title": string,
  "observationType": enum (ObservationType),
  "observerType": enum (ObserverType),
  "text": string,
  "data": {
    object
  },
  "dataUrls": {
    string: string,
    ...
  },
  "knowledgeUrls": {
    string: string,
    ...
  },
  "baseObservations": [
    string
  ],
  "relevantResources": [
    string
  ],
  "recommendation": string,
  "systemRelevanceScore": number,
  "relevanceOverride": enum (UserRelevance),
  "observationCompletionState": enum (ObservationCompletionState),
  "observedNormalOperation": boolean
}
Champs
id

string

Obligatoire. Il identifie de manière unique cette observation. Il doit dépendre du contenu principal de l'observation, et non de sa pertinence, par exemple. Il ne doit dépendre d'aucun élément qui peut varier de manière imprévisible entre différentes révisions pour s'exécuter. Il s'agit également de la clé du mappage dans l'investigation parente. Les ID doivent être hiérarchiques, utiliser un point (".") comme séparateur, et commencer par le nom de l'observateur. Par exemple, "diagnostics.runbook.ABC", "signals.logs" ou "user.input.2". Les ID doivent pouvoir être utilisés comme composant d'URL. (Non sensibles à la casse, [a-z0-9-._]+) — Ces ID ne seront pas visibles par les utilisateurs, mais apparaîtront dans le modèle de données. Ils permettent aux ingénieurs Google de localiser les bugs et doivent donc être partiellement lisibles.
timeIntervals[]

object (Interval)

Facultatif. Intervalle durant lequel cette observation a été effectuée. Les observations doivent inclure au moins une plage de dates pour pouvoir être affichées sur une chronologie et faciliter ainsi la recherche des événements associés. Dans le cas d'un événement répété, mais non continu, il est approprié d'utiliser plusieurs plages. L'UI peut les regrouper.
title

string

Facultatif. Étiquette affichée dans l'UI. Elle n'a pas besoin d'être unique au sein d'une investigation. Toutefois, elle doit rester spécifique et contenir moins de 80 caractères pour que l'utilisateur puisse facilement l'identifier parmi plusieurs observations. Une étiquette indiquant "Nettools pod configured with ALL capabilities dropped" est beaucoup plus claire que "Interesting pod configuration".
observationType

enum (ObservationType)

Obligatoire. Type d'observation (par exemple, journal, métrique, etc.)
observerType

enum (ObserverType)

Obligatoire. Origine des données (utilisateur, code système, LLM, etc.)
text

string

Facultatif. Texte en langage naturel [markdown] associé à l'observation. Il s'agit du contenu principal, et non d'une description de métadonnées.
data

object (Struct format)

Facultatif. Représentation structurée de l'observation, telle que choisie par l'observateur. Facultatif. Si la représentation est fournie, l'observateur DOIT également fournir une description textuelle de l'observation afin de faciliter son traitement par un LLM ainsi que son affichage dans l'UI.
dataUrls

map (key: string, value: string)

Facultatif. Mappage entre des noms lisibles par l'humain et des URL d'éléments de preuve. La clé de mappage s'affiche sous forme de texte d'ancrage d'URL. Remplissez ce champ chaque fois qu'une observation dépend d'un élément extérieur au système. Par exemple, une requête de journalisation ou de métriques qui peut générer de nouveau l'observation.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
knowledgeUrls

map (key: string, value: string)

Facultatif. Mappage entre des noms lisibles par l'humain et des URL de documentation.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
baseObservations[]

string

Facultatif. ID des autres observations sur lesquelles cette observation est basée. Par exemple, une observation de conclusion enregistre les observations qui ont été utilisées pour la générer. Un paramètre extrait enregistre la source à partir de laquelle il a été extrait. Le graphe des prémisses et des conclusions sera acyclique au sein d'une révision.
relevantResources[]

string

Facultatif. Ressources Google Cloud pertinentes pour l'observation. Il doit s'agir d'URI de ressources complets, par exemple : "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance"
recommendation

string

Facultatif. Texte en langage naturel [markdown] décrivant une action recommandée pour corriger la cause première. Il s'agit d'un champ au format libre qui n'est pas traité automatiquement pour le moment. Une recommandation peut correspondre à des descriptions générales des résolutions, à des étapes de résolution spécifiques et tactiques incluant des commandes exécutables, ou à des étapes de dépannage spécifiques et tactiques pour orienter la suite de la recherche qui incluent des commandes exécutables.
systemRelevanceScore

number

Facultatif. Pertinence de cette observation pour l'investigation, telle qu'inférée par le système. Facultatif. La valeur doit être comprise entre -1 et 1. Représente le niveau de confiance accordé à l'explication fournie dans OBSERVATION_TYPE_HYPOTHESIS. Seules les hypothèses de cause sont classées les unes par rapport aux elles. Pour les autres champs ObservationType, il s'agit d'un score de pertinence. Ces types d'observation sont également classés les uns par rapport aux autres. Une valeur de 0 est neutre.
relevanceOverride

enum (UserRelevance)

Facultatif. Avis de l'utilisateur concernant la pertinence.
observationCompletionState

enum (ObservationCompletionState)

Facultatif. Un ObservationCompletionState indique si l'observation générée est complète et prête à être présentée à l'utilisateur. Cela permet de masquer les observations qui se trouvent dans un état intermédiaire.
observedNormalOperation

boolean

Facultatif. Indique si cette observation nous fournit des informations sur un problème ou une cause (false) ou si elle signale un fonctionnement normal (true). Ce concept diffère de la pertinence, et il est utilisé différemment. Une observation non pertinente doit être masquée à la fois pour le LLM et pour l'utilisateur. Une observation pertinente signalant un problème doit être présentée comme telle et peut alimenter une hypothèse. Une conclusion de normalité pertinente peut ou non être affichée dans l'UI, mais elle doit être prise en compte par le LLM pour éliminer les hypothèses contredites par cette conclusion.

ObservationType

Correspond au type de données constituant une observation. Cet aspect est indépendant de la provenance : un journal peut être fourni explicitement par l'utilisateur, extrait par l'IA ou repéré par un runbook.

Énumérations
OBSERVATION_TYPE_UNSPECIFIED Ne pas utiliser. Spécifiez le type d'observation. Ajoutez une énumération si nécessaire.
OBSERVATION_TYPE_CLOUD_LOG Le texte de cette observation est une entrée de journal.
OBSERVATION_TYPE_CLOUD_METRIC Le contenu de cette observation est une métrique ou un groupe de métriques.
OBSERVATION_TYPE_CAIS_CONFIG Configuration
OBSERVATION_TYPE_CAIS_CONFIG_DIFF Modification de la configuration
OBSERVATION_TYPE_CLOUD_ALERT Alerte
OBSERVATION_TYPE_CICD_EVENT Événement provenant d'un système d'intégration continue, par exemple un échec du vérificateur.
OBSERVATION_TYPE_TEXT_DESCRIPTION Entrée de texte libre, telle que l'entrée initiale de l'utilisateur. Peut être au format Markdown.
OBSERVATION_TYPE_HYPOTHESIS Il s'agit de conclusions [provisoires] émises par le système. Elles peuvent devenir des entrées dans une révision ultérieure. Dans ce cas, les recommandations seront utilisées, mais pas la correction.
OBSERVATION_TYPE_STRUCTURED_INPUT Entrée structurée, par exemple des paramètres de runbook saisis dans un formulaire.
OBSERVATION_TYPE_COMPOSITE Utilisé pour une observation qui inclut plusieurs types de preuves, comme une sortie de runbook.
OBSERVATION_TYPE_OTHER La sortie du runbook peut être "autre" si aucun des autres types ne s'applique.
OBSERVATION_TYPE_LOG_THEME Un thème découvert dans les journaux.
OBSERVATION_TYPE_CONFIG_ANALYSIS Signale une sortie incluant une configuration analysée par le LLM.
OBSERVATION_TYPE_OUTAGE Signale une sortie incluant un incident de PSH.
OBSERVATION_TYPE_KNOWLEDGE Texte fournissant des informations sur le problème spécifique d'un utilisateur. Par exemple, des instructions ou des liens externes du catalogue d'erreurs, des RAG, etc.

ObserverType

Cela indique comment les données ont été ajoutées à l'investigation.

Énumérations
OBSERVER_TYPE_UNSPECIFIED Ne pas utiliser. Indiquez l'origine de l'observation. Ajoutez une énumération si nécessaire.
OBSERVER_TYPE_DIAGNOSTICS Nous les séparons pour des raisons d'attribution interne. Les diagnostics intègrent une notion explicite de cause racine, par exemple via des runbooks.
OBSERVER_TYPE_SIGNALS Les signaux servent à traiter les problèmes dont les causes ne sont pas clairement identifiées.
OBSERVER_TYPE_DETERMINISTIC_CODE Cela concerne le code qui dépend uniquement des prémisses. Par exemple, des recherches effectuées dans le catalogue d'erreurs.
OBSERVER_TYPE_AI Cela concerne les inférences d'IA réalisées en cours de traitement qui dépendent uniquement des observations désignées comme prémisses.
OBSERVER_TYPE_USER Observation de l'entrée utilisateur, y compris les réponses aux clarifications.
OBSERVER_TYPE_ALERT Observation provenant d'une alerte externe à GCA.

UserRelevance

Il s'agit de l'avis exprimé par l'utilisateur concernant la pertinence d'une observation. L'interface utilisateur peut afficher un bouton "J'aime" ou "Je n'aime pas".

Énumérations
USER_RELEVANCE_UNSPECIFIED L'utilisateur n'a pas indiqué si cette observation était pertinente ou non.
USER_RELEVANCE_PROMOTED L'utilisateur a marqué cette observation comme pertinente.
USER_RELEVANCE_REJECTED L'utilisateur a marqué cette observation comme non pertinente.

ObservationCompletionState

Indique si l'observation est entièrement formée et complète. De plus, cela détermine si l'observation est présentée à l'utilisateur.

Énumérations
OBSERVATION_COMPLETION_STATE_UNSPECIFIED Ne pas utiliser.
OBSERVATION_COMPLETION_STATE_COMPLETE Cette observation est complète et doit être présentée à l'utilisateur.
OBSERVATION_COMPLETION_STATE_INCOMPLETE Il manque des informations dans cette observation, ou elle doit être traitée par un autre observateur. Ce type d'observation ne doit pas être conservé dans les révisions ultérieures de l'investigation.

ObserverStatus

Un ObserverStatus représente l'état d'un observateur à un moment précis de l'exécution d'une investigation. REMARQUE : Par défaut, rien n'est masqué dans ce message. Les composants ne doivent PAS inclure d'informations permettant d'identifier personnellement l'utilisateur ou d'informations d'identification de carte de crédit, sauf si celles-ci sont masquées. ID suivant : 13.

Représentation JSON 
{
  "observer": string,
  "observerExecutionState": enum (ObserverExecution),
  "observerDisplayName": string,
  "updateTime": string,
  "startTime": string,
  "updateComment": string,
  "observerErrors": [
    {
      object (Status)
    }
  ]
}
Champs
observer

string

Obligatoire. ID de l'observateur auquel s'applique cet état. Les ID d'observateur doivent être lisibles par l'humain et hiérarchiques, par exemple "signals.logs.firewall_rules" ou "diagnostics.error_catalog".
observerExecutionState

enum (ObserverExecution)

Facultatif. État actuel de l'exécution de l'observateur.
observerDisplayName

string

Obligatoire. Nom à présenter à l'utilisateur lors de la description de cet observateur. Notez que l'UI peut remplacer cette chaîne par une version internationalisée. Vous ne devez donc pas la générer de manière dynamique. Obligatoire pour que l'utilisateur puisse identifier l'observateur (par exemple, un runbook) auquel le système fait référence.
updateTime

string (Timestamp format)

Facultatif. Heure à laquelle l'état a été mis à jour. Facultatif, étant donné que c'est l'observateur qui doit indiquer cette valeur. Devient la valeur endTime lorsque l'observateur a terminé.

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Facultatif. Heure à laquelle l'observateur a commencé. Facultatif, étant donné que c'est l'observateur qui doit indiquer cette valeur. Une fois que l'observateur a terminé, la différence entre cette valeur et updateTime correspond à la durée d'exécution de l'observateur.

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateComment

string

Facultatif. Mise à jour de l'état renseigné par l'observateur. Peut être consignée à des fins de débogage. Peut être présentée aux utilisateurs. Exemples de bonne mise à jour : "parameters matched, queued for execution" ou "checked log file 2/5".
observerErrors[]

object (Status)

Facultatif. Erreur dans le système d'investigation qui empêchait un observateur de faire une observation particulière. Dans ce cas, les utilisateurs voient la chaîne d'erreur. Répété, car plusieurs autorisations peuvent manquer à un observateur.

ObserverExecution

État de l'observateur.

Énumérations
OBSERVER_EXECUTION_UNSPECIFIED L'état de l'observateur n'est pas spécifié.
OBSERVER_EXECUTION_NOT_STARTED L'investigation n'a pas encore commencé.
OBSERVER_EXECUTION_RUNNING L'investigation est en cours, et cet observateur est exécutable ou en cours d'exécution.
OBSERVER_EXECUTION_COMPLETE L'observateur a terminé sans erreur interne.
OBSERVER_EXECUTION_FAILED L'observateur a tenté de s'exécuter, mais a échoué en raison d'une erreur. Cette valeur est spécifique à un composant et peut être affichée dans l'UI si l'observation est visible, avec une priorité très faible.
OBSERVER_EXECUTION_BLOCKED L'observateur est bloqué en attendant une entrée.
OBSERVER_EXECUTION_INVESTIGATION_BLOCKED L'observateur signale une erreur qui bloque ou affecte gravement l'investigation (par exemple, une journalisation ou un flux CAIS désactivés). Doit être affiché de manière bien visible dans l'UI.
OBSERVER_EXECUTION_INVESTIGATION_DEGRADED L'observateur signale une erreur impactant l'investigation et qui peut nécessiter que l'utilisateur escalade ou relance l'investigation après avoir identifié la cause et résolu le problème.

AbsentObservation

Identifiant d'une observation requise. Il s'agit généralement d'un paramètre, mais qui peut être étendu à d'autres cas.

Représentation JSON 
{

  // Union field t can be only one of the following:
  "param": string,
  "generalMissingObservation": {
    object (GeneralAbsentObservation)
  },
  "pendingObservation": string
  // End of list of possible types for union field t.
}
Champs
Champ d'union t. Il existe plusieurs types de paramètres manquants. t ne peut être qu'un des éléments suivants :
param

string

Facultatif. Paramètre de runbook.
generalMissingObservation

object (GeneralAbsentObservation)

Facultatif. Observation manquante que l'utilisateur pourrait fournir et qui n'est pas un paramètre de runbook.
pendingObservation

string

Facultatif. Observation qui n'a pas encore été créée et qu'un observateur doit créer en s'exécutant. Cela peut inciter le système à exécuter un runbook.

GeneralAbsentObservation

Observation absente qui n'est pas un paramètre de runbook.

Représentation JSON 
{
  "id": string,
  "title": string,
  "validationRegex": string
}
Champs
id

string

Facultatif. ID de l'observation manquante.
title

string

Facultatif. Titre à afficher dans l'UI.
validationRegex

string

Facultatif. Expression régulière à laquelle la réponse doit correspondre. Doit respecter la syntaxe des modèles de chaîne d'expression régulière de JavaScript. Consultez la page https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp#syntax.

ObserverLogEntry

Entrée de journal d'un observateur.

Représentation JSON 
{
  "logTime": string,
  "logMessage": string,
  "logSeverity": enum (LogSeverity),
  "data": {
    object
  },
  "sensitiveData": {
    object
  }
}
Champs
logTime

string (Timestamp format)

Obligatoire. Heure à laquelle le journal a été créé.

Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
logMessage

string

Obligatoire. Message lisible par l'humain.
logSeverity

enum (LogSeverity)

Obligatoire. Niveau de gravité du message de journal.
data

object (Struct format)

Facultatif. Toutes données supplémentaires, comme une erreur RPC. Avertissement : comme pour le reste d'ObserverStatus, il est possible de consulter le contenu de ce champ à des fins de débogage de l'observateur. Pour les données sensibles, utilisez plutôt sensitiveData.
sensitiveData

object (Struct format)

Facultatif. Toutes données supplémentaires pouvant contenir des informations sensibles sur le projet faisant l'objet de l'investigation. Ce champ est masqué quand l'état de l'observateur (ObserverStatus) est consulté à des fins de débogage.

LogSeverity

Gravité de l'événement décrit dans une entrée de journal, exprimée avec l'un des niveaux de gravité standards listés ci-dessous. À titre indicatif, les niveaux sont associés aux valeurs numériques listées. L'effet de l'utilisation de valeurs numériques autres que celles listées n'est pas défini.

Vous pouvez filtrer les entrées de journal par niveau de gravité. Par exemple, l'expression de filtre suivante correspond aux entrées de journal dont le niveau de gravité est INFO, NOTICE et WARNING :

severity > DEBUG AND severity <= WARNING

Si vous écrivez des entrées de journal, vous devez mapper les autres encodages de gravité à l'un de ces niveaux standards. Par exemple, vous pouvez mapper tous les niveaux FINE, FINER et FINEST de Java à LogSeverity.DEBUG. Si vous le souhaitez, vous pouvez conserver le niveau de gravité d'origine dans la charge utile de l'entrée de journal.

Énumérations
DEFAULT (0) L'entrée de journal ne comporte pas de niveau de gravité défini.
DEBUG (100) Informations de débogage ou de trace.
INFO (200) Informations courantes, telles que l'état d'avancement ou les performances.
NOTICE (300) Événements normaux, mais importants, tels qu'un démarrage, un arrêt ou une modification de la configuration.
WARNING (400) Événements de type avertissement pouvant entraîner des problèmes.
ERROR (500) Événements d'erreur pouvant causer des problèmes.
CRITICAL (600) Événements critiques entraînant des problèmes ou des indisponibilités plus graves.
ALERT (700) Une personne doit prendre des mesures immédiatement.
EMERGENCY (800) Un ou plusieurs systèmes sont inutilisables.

ClarificationNeeded

Clarification requise par le système.

Représentation JSON 
{
  "runbookParameter": {
    object (RunbookParameter)
  },
  "generalMissingObservation": {
    object (GeneralAbsentObservation)
  },
  "parentObserverNames": [
    string
  ]
}
Champs
runbookParameter

object (RunbookParameter)

Facultatif. Le résultat d'une clarification est une observation. Paramètre de runbook que l'utilisateur doit fournir.
generalMissingObservation

object (GeneralAbsentObservation)

Facultatif. Observation manquante qui n'est pas un paramètre de runbook.
parentObserverNames[]

string

Facultatif. Noms à afficher des observateurs qui ont demandé cette clarification. L'UI effectuera les regroupements selon ces noms.

RunbookParameter

Métadonnées de paramètres pour les runbooks mis à jour par la tâche de diagnostic.

Représentation JSON 
{
  "id": string,
  "displayName": string,
  "description": string,
  "exampleValues": [
    string
  ],
  "value": string,
  "associatedAssetTypes": [
    string
  ]
}
Champs
id

string

Facultatif. Nom du paramètre.
displayName

string

Facultatif. Nom de paramètre à afficher pour l'utilisateur.
description

string

Facultatif. Description du paramètre.
exampleValues[]

string

Facultatif. Exemples de valeurs de paramètre.
value

string

Facultatif. Valeur du paramètre, si disponible.
associatedAssetTypes[]

string

Facultatif. Si ces éléments sont présents, il s'agit d'une liste des types de ressources auxquels ce paramètre peut correspondre. Par exemple : "compute.googleapis.com/Instance".

Méthodes

create

 Crée une investigation dans un projet et un emplacement donnés.

delete

 Supprime une seule investigation.

get

 Récupère les détails d'une seule investigation.

getIamPolicy

 Récupère la stratégie de contrôle des accès d'une ressource.

list

 Liste les investigations d'un projet et d'un emplacement donnés.

patch

 Met à jour les paramètres d'une seule investigation.

setIamPolicy

 Définit la stratégie de contrôle d'accès sur la ressource spécifiée.

testIamPermissions

 Renvoie les autorisations qu'un appelant a sur la ressource spécifiée.