REST Resource: projects.locations.investigations

Ressource: Untersuchung

Nachricht zur Beschreibung des Prüfungsobjekts „Next Id: 24“

JSON-Darstellung 
{
  "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)
    },
    ...
  }
}
Felder
name

string

Kennung. Name der Ressource
createTime

string (Timestamp format)

Nur Ausgabe. [Nur Ausgabe] Zeitstempel der Erstellung

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Nur Ausgabe. [Nur Ausgabe] Zeitstempel der Aktualisierung

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
labels

map (key: string, value: string)

Optional. Labels als Schlüssel/Wert-Paare

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
revision

string

Nur Ausgabe. [Nur Ausgabe] Aktuelle Überarbeitung der Untersuchung
revisionIndex

integer

Nur Ausgabe. [Nur Ausgabe] Index der aktuellen Überarbeitung der Untersuchung. 1-basiert.
revisionPredecessor

string

Optional. Der Name der Überarbeitung, die der Vorgänger dieser Überarbeitung war. In der Benutzeroberfläche wird dieser Wert beispielsweise auf die vorhandene Version festgelegt, wenn aufgrund einer Bearbeitung eine neue Version erstellt wird.
annotations

object (InvestigationAnnotations)

Optional. Annotationen zur Untersuchung. Im Gegensatz zu Labels können diese eine semantische Bedeutung für die Durchführung der Untersuchung haben und werden nicht von anderen Systemen wie der Abrechnung gelesen.
executionState

enum (InvestigationExecutionState)

Nur Ausgabe. [Nur Ausgabe] Der Ausführungsstatus dieser Untersuchung.
error

object (Status)

Nur Ausgabe. [Nur Ausgabe] Wenn der Ausführungsstatus der Untersuchung FAILED ist, enthält dieses Feld die Fehlermeldung.
operation

string

Nur Ausgabe. Der zuletzt für die Untersuchung ausgeführte Vorgang „Ausführen“.
title

string

Erforderlich. Für Menschen lesbarer Anzeigetitel für die Untersuchung.
observations

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

Optional. Eine Zuordnung von der Beobachtungs-ID zur Beobachtung. Dies ist eine Zuordnung, damit wir alte Beobachtungen sauber mit der Version aus der letzten Überarbeitung überschreiben können. Weitere Informationen zur Auswahl von IDs finden Sie unter „Beobachtung“.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
observerStatuses

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

Optional. Pluralform des oben genannten Begriffs. Der Code wird im Laufe der Zeit auf diese Weise umgestellt.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
clarificationsNeeded

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

Optional. Fragen, die das System dem Nutzer stellen muss. Die Ergebnisse werden von der Benutzeroberfläche als neue Beobachtungen zurückgegeben. Die ID für diese Beobachtungen ist der Schlüssel des Eintrags in der Map „clarificationsNeeded“.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

InvestigationAnnotations

Zusätzliche benutzerdefinierte Anmerkungen zu einer Untersuchung. Es gibt einige vordefinierte und eine Karte für neue Anwendungen, in denen eigene hinzugefügt werden können.

JSON-Darstellung 
{
  "followUp": boolean,
  "extrasMap": {
    string: string,
    ...
  },
  "revisionLastRunInterval": {
    object (Interval)
  }
}
Felder
followUp

boolean

Nur Ausgabe. Für die Fortsetzung der Untersuchung ist eine Reaktion erforderlich. Wird in der Regel von der Fehlerbehebung auf „true“ gesetzt und auf „false“, wenn die Fragen beantwortet wurden.
extrasMap

map (key: string, value: string)

Optional. Zusätzliche Anmerkungen, die von Anwendungen benötigt werden. Diese werden nicht geschwärzt und dürfen KEINE Kreditkarteninformationen oder personenidentifizierbaren Informationen enthalten.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
revisionLastRunInterval

object (Interval)

Optional. Start- und Endzeitpunkt der letzten Ausführung der Überarbeitung.

Intervall

Stellt ein Zeitintervall dar, das als Timestamp-Start (einschließlich) und Timestamp-Ende (ausschließlich) codiert ist.

Der Start muss kleiner oder gleich dem Ende sein. Wenn der Start dem Ende entspricht, ist das Intervall leer (es wird keine Zeit abgeglichen). Wenn sowohl „start“ als auch „end“ nicht angegeben sind, entspricht das Intervall jeder Zeit.

JSON-Darstellung 
{
  "startTime": string,
  "endTime": string
}
Felder
startTime

string (Timestamp format)

Optional. Einbezogener Beginn des Intervalls.

Wenn angegeben, muss ein Zeitstempel, der diesem Intervall entspricht, mit dem Start übereinstimmen oder danach liegen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Optional. Ausgeschlossenes Ende des Intervalls.

Wenn angegeben, muss ein Zeitstempel, der diesem Intervall entspricht, vor dem Ende liegen.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

InvestigationExecutionState

Der Ausführungsstatus einer Untersuchung.

Enums
INVESTIGATION_EXECUTION_STATE_UNSPECIFIED Standardwert Dieser Wert wird nicht verwendet.
INVESTIGATION_EXECUTION_STATE_RUNNING Die Prüfung wird ausgeführt.
INVESTIGATION_EXECUTION_STATE_MODIFIED Die Untersuchung wurde noch nicht durchgeführt, seit das Symptom zuletzt aktualisiert wurde.
INVESTIGATION_EXECUTION_STATE_FAILED Die Ausführung der Untersuchung ist abgeschlossen, aber fehlgeschlagen.
INVESTIGATION_EXECUTION_STATE_COMPLETED Alle Ausführungsaufgaben wurden abgeschlossen und die Untersuchung ist abgeschlossen.

Beobachtung

Eine Beobachtung ist die Grundeinheit für den Austausch zwischen Nutzer und System oder zwischen verschiedenen Komponenten des Systems. Es ist das Element, das eine Relevanz hat. Sie sollten daher relativ klein sein. Wenn Sie erwarten, dass Nutzer auf einen „Teil“ einer Beobachtung reagieren, sollte diese in kleinere Beobachtungen unterteilt werden. Ein bestimmter Runbook-Lauf, eine bestimmte Nutzereingabe für einen Parameter oder ein bestimmter interessanter Logeintrag können jeweils eine separate Beobachtung sein. Das bedeutet, dass es bei einer Untersuchung Dutzende oder Hunderte geben kann. Nächste ID: 26

JSON-Darstellung 
{
  "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
}
Felder
id

string

Erforderlich. Eindeutige Kennung für diese Beobachtung. Sollte vom „Kerninhalt“ der Beobachtung abhängen, nicht aber z.B. von der Relevanz. Sollte nicht von Dingen abhängen, die von Revision zu Revision und von Lauf zu Lauf unvorhersehbar variieren können. Dies ist auch der Kartenschlüssel in der übergeordneten Untersuchung. Sie sollten hierarchisch sein und „.“ als Trennzeichen verwenden. Der Name des Beobachters sollte am Anfang stehen. Beispiele: diagnostics.runbook.ABC, signals.logs oder user.input.2. Der Name sollte als URL-Komponente verwendet werden können. (Nicht case-sensitiv [a-z0-9-._]+) Diese werden Nutzern nicht angezeigt, sind aber im Datenmodell sichtbar. Sie werden von Google-Entwicklern verwendet, um Fehler zu lokalisieren, und sollten daher halbwegs lesbar sein.
timeIntervals[]

object (Interval)

Optional. Zeitpunkt der Beobachtung Beobachtungen sollten mindestens einen Zeitraum haben, damit sie auf einer Zeitachse dargestellt und zugehörige Ereignisse gefunden werden können. Bei einem wiederholten, aber nicht kontinuierlichen Ereignis sind mehrere Bereiche angemessen. In der Benutzeroberfläche werden diese möglicherweise kombiniert.
title

string

Optional. Das in der Benutzeroberfläche angezeigte Label. Dies muss nicht innerhalb einer Untersuchung eindeutig sein. Er sollte jedoch spezifisch sein und weniger als 80 Zeichen umfassen, damit der Nutzer viele Beobachtungen leicht erfassen kann. „Nettools-Pod mit ALLEN Funktionen konfiguriert, die entfernt wurden“ ist viel besser als „Interessante Pod-Konfiguration“.
observationType

enum (ObservationType)

Erforderlich. Der Typ der Beobachtung (z.B. Log, Messwert usw.)
observerType

enum (ObserverType)

Erforderlich. Die Quelle der Daten, z.B. Nutzer, Systemcode, LLM usw.
text

string

Optional. [Markdown]-Text in natürlicher Sprache, der mit der Beobachtung verknüpft ist. Das ist der eigentliche Inhalt, nicht eine Metadatenbeschreibung.
data

object (Struct format)

Optional. Eine strukturierte Darstellung der Beobachtung, die vom Beobachter ausgewählt wurde. Optional. Falls vorhanden, SOLLTE ein Beobachter auch eine Textbeschreibung der Beobachtung angeben, um die Verarbeitung durch ein LLM und das Rendern in der Benutzeroberfläche zu erleichtern.
dataUrls

map (key: string, value: string)

Optional. Eine Zuordnung von menschenlesbaren Namen zu URLs für unterstützende Beweise. Der Zuordnungsschlüssel wird als URL-Ankertext gerendert. Füllen Sie dieses Feld aus, wenn eine Beobachtung von etwas außerhalb des Systems abhängt. Beispiel: Eine Abfrage für Logs/Messwerte usw., mit der die Beobachtung neu generiert werden kann.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
knowledgeUrls

map (key: string, value: string)

Optional. Eine Zuordnung von menschenlesbaren Namen zu URLs für die Dokumentation.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
baseObservations[]

string

Optional. Die IDs anderer Beobachtungen, auf denen diese Beobachtung basiert. In einer Schlussfolgerung werden beispielsweise die Beobachtungen aufgezeichnet, die zu ihrer Generierung verwendet wurden. Bei einem extrahierten Parameter wird aufgezeichnet, woraus er extrahiert wurde. Der Graph der Prämissen und Schlussfolgerungen ist innerhalb einer Überarbeitung azyklisch.
relevantResources[]

string

Optional. Die für die Beobachtung relevanten Google Cloud-Ressourcen. Dies sollten vollständig qualifizierte Ressourcen-URIs sein, z.B. "//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance"
recommendation

string

Optional. [Markdown]-Text in natürlicher Sprache, der eine empfohlene Maßnahme zur Behebung der Ursache beschreibt. Das ist ein Freiformfeld und wird derzeit nicht maschinell verarbeitet. Eine Empfehlung kann Folgendes sein: - Allgemeine Beschreibungen von Abhilfemaßnahmen - Spezifische und taktische Schritte zur Fehlerbehebung mit ausführbaren Befehlen - Spezifische und taktische Schritte zur Fehlerbehebung, um mit ausführbaren Befehlen zu ermitteln, wo als Nächstes untersucht werden muss
systemRelevanceScore

number

Optional. Wie relevant diese Beobachtung für die Untersuchung ist, wie vom System abgeleitet. Optional. Sollte im Bereich [-1, 1] liegen. Für OBSERVATION_TYPE_HYPOTHESIS steht dieser Wert für das Vertrauen in die Erklärung. Nur Hypothesen zur Ursache werden miteinander verglichen. Bei anderen ObservationTypes wird damit eine Relevanzbewertung dargestellt und die Werte werden miteinander verglichen. Ein Wert von 0 ist neutral.
relevanceOverride

enum (UserRelevance)

Optional. Die Relevanzbewertung des Nutzers.
observationCompletionState

enum (ObservationCompletionState)

Optional. Ein „ObservationCompletionState“ gibt an, ob die ausgegebene Beobachtung vollständig ist und dem Nutzer angezeigt werden sollte. So können Beobachtungen ausgeblendet werden, die sich in einem Zwischenstatus befinden.
observedNormalOperation

boolean

Optional. Gibt an, ob diese Beobachtung Informationen zu einem Problem / einer Ursache (falsch) oder zum normalen Betrieb (wahr) liefert. Das Konzept unterscheidet sich von der Relevanz und wird anders verwendet. Eine irrelevante Beobachtung sollte vor dem LLM und dem Nutzer verborgen werden. Eine relevante Beobachtung eines Problems sollte als Beobachtung dargestellt werden und eine Hypothese motivieren. Ein relevantes Ergebnis der Normalitätsprüfung wird möglicherweise in der Benutzeroberfläche angezeigt, sollte aber vom LLM verwendet werden, um Hypothesen herauszufiltern, die durch das Ergebnis widerlegt werden.

ObservationType

Dies stellt den Datentyp dar, aus dem eine Beobachtung besteht. Das ist unabhängig von der Herkunft: Ein Log kann explizit vom Nutzer bereitgestellt, über KI extrahiert oder von einem Runbook erkannt werden.

Enums
OBSERVATION_TYPE_UNSPECIFIED Nicht verwenden. Geben Sie den Typ der Beobachtung an. Fügen Sie bei Bedarf ein neues Enum hinzu.
OBSERVATION_TYPE_CLOUD_LOG Der Text dieser Beobachtung ist ein Logeintrag.
OBSERVATION_TYPE_CLOUD_METRIC Der Inhalt dieser Beobachtung ist ein Messwert oder eine Gruppe von Messwerten.
OBSERVATION_TYPE_CAIS_CONFIG Konfiguration
OBSERVATION_TYPE_CAIS_CONFIG_DIFF Konfigurationsänderung
OBSERVATION_TYPE_CLOUD_ALERT Eine Benachrichtigung
OBSERVATION_TYPE_CICD_EVENT Ein Ereignis aus einem Continuous-Integration-System, z.B. ein Prober-Fehler.
OBSERVATION_TYPE_TEXT_DESCRIPTION Freie Texteingabe, z. B. die ursprüngliche Nutzereingabe. Kann Markdown enthalten.
OBSERVATION_TYPE_HYPOTHESIS Dies gilt für [vorläufige] Schlussfolgerungen, die vom System gezogen werden. Diese können als Eingaben für eine nachfolgende Überarbeitung dienen. In diesem Fall werden die Empfehlungen verwendet, aber nicht die Korrektur.
OBSERVATION_TYPE_STRUCTURED_INPUT Strukturierte Eingabe, z.B. Runbook-Parameter in einem Formular
OBSERVATION_TYPE_COMPOSITE Wird für eine Beobachtung verwendet, die mehr als eine Art von Beweismittel enthält, z. B. eine Runbook-Ausgabe.
OBSERVATION_TYPE_OTHER Die Runbook-Ausgabe kann „other“ (Sonstiges) sein, wenn keiner der anderen Typen zutrifft.
OBSERVATION_TYPE_LOG_THEME Ein in den Logs entdecktes Thema.
OBSERVATION_TYPE_CONFIG_ANALYSIS Signalausgabe, die eine von einem LLM analysierte Konfiguration enthält.
OBSERVATION_TYPE_OUTAGE Signalausgabe, die einen Ausfall von PSH enthält.
OBSERVATION_TYPE_KNOWLEDGE Text, der Informationen zum Problem eines bestimmten Nutzers enthält. Beispiele: Anleitungen/externe Links zum Fehlerkatalog, RAG usw.

ObserverType

Hier sehen Sie, wie die Daten in die Untersuchung gelangt sind.

Enums
OBSERVER_TYPE_UNSPECIFIED Nicht verwenden. Geben Sie an, woher die Beobachtung stammt. Fügen Sie bei Bedarf ein neues Enum hinzu.
OBSERVER_TYPE_DIAGNOSTICS Wir trennen diese aus internen Attributionsgründen. Bei der Diagnose gibt es eine explizite Vorstellung von Ursachen, z.B. über Runbooks.
OBSERVER_TYPE_SIGNALS „Signale“ ist für die Verarbeitung ohne explizite Ursachen vorgesehen.
OBSERVER_TYPE_DETERMINISTIC_CODE Dies gilt für Code, der nur von Räumlichkeiten abhängt. Insbesondere Fehlerkatalog-Lookups.
OBSERVER_TYPE_AI Das gilt für KI-Schlussfolgerungen, die auf dem Weg gezogen werden und nur auf Beobachtungen beruhen, die als Prämissen aufgeführt sind.
OBSERVER_TYPE_USER Beobachtung der Nutzereingabe, einschließlich Antworten auf Klarstellungen.
OBSERVER_TYPE_ALERT Eine Beobachtung aus einer Benachrichtigung, die nicht von GCA stammt.

UserRelevance

Dies entspricht der vom Nutzer geäußerten Relevanzbewertung einer Beobachtung. Die Benutzeroberfläche wird etwa wie „Mag ich“ oder „Mag ich nicht“ aussehen.

Enums
USER_RELEVANCE_UNSPECIFIED Der Nutzer hat diese Beobachtung nicht als relevant oder irrelevant markiert.
USER_RELEVANCE_PROMOTED Der Nutzer hat diese Beobachtung als relevant markiert.
USER_RELEVANCE_REJECTED Der Nutzer hat diese Beobachtung als irrelevant markiert.

ObservationCompletionState

Gibt an, ob die Beobachtung vollständig ist. Nebenbei wird dadurch auch festgelegt, ob die Beobachtung dem Nutzer angezeigt wird.

Enums
OBSERVATION_COMPLETION_STATE_UNSPECIFIED Nicht verwenden.
OBSERVATION_COMPLETION_STATE_COMPLETE Diese Beobachtung ist vollständig und sollte dem Nutzer angezeigt werden.
OBSERVATION_COMPLETION_STATE_INCOMPLETE Für diese Beobachtung fehlen einige Informationen oder sie muss von einem anderen Beobachter weiterverarbeitet werden. Diese Art von Beobachtung sollte nicht in zukünftigen Überarbeitungen der Untersuchung beibehalten werden.

ObserverStatus

Ein ObserverStatus repräsentiert den Status eines Beobachters zu einem bestimmten Zeitpunkt während der Ausführung einer Untersuchung. HINWEIS: Standardmäßig wird in dieser Nachricht nichts unkenntlich gemacht. Komponenten sollten hier KEINE personenbezogenen Daten / Kreditkarteninformationen einfügen, es sei denn, sie wurden unkenntlich gemacht. Nächste ID: 13

JSON-Darstellung 
{
  "observer": string,
  "observerExecutionState": enum (ObserverExecution),
  "observerDisplayName": string,
  "updateTime": string,
  "startTime": string,
  "updateComment": string,
  "observerErrors": [
    {
      object (Status)
    }
  ]
}
Felder
observer

string

Erforderlich. Die ID des Beobachters, für den dieser Status gilt. Beobachter-IDs sollten für Menschen lesbar und hierarchisch sein, z.B. „signals.logs.firewall_rules“ oder „diagnostics.error_catalog“.
observerExecutionState

enum (ObserverExecution)

Optional. Der aktuelle Ausführungsstatus des Beobachters.
observerDisplayName

string

Erforderlich. Der Name, der dem Nutzer angezeigt wird, wenn dieser Beobachter beschrieben wird. Hinweis: Die Benutzeroberfläche ersetzt diese möglicherweise durch eine internationalisierte Version. Sie sollte daher nicht dynamisch generiert werden. Erforderlich, damit der Nutzer sehen kann, auf welchen Observer (z.B. Runbook) sich das System bezieht.
updateTime

string (Timestamp format)

Optional. Der Zeitpunkt, zu dem der Status aktualisiert wurde. Optional, da der Beobachter dafür verantwortlich ist, sie festzulegen. Wird zu „endTime“, wenn der Observer abgeschlossen ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
startTime

string (Timestamp format)

Optional. Der Zeitpunkt, zu dem der Beobachter gestartet wurde. Optional, da der Beobachter dafür verantwortlich ist, sie festzulegen. Wenn der Beobachter fertig ist, ist die Differenz zwischen diesem und updateTime die Laufzeit des Beobachters.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
updateComment

string

Optional. Eine Statusaktualisierung durch den Beobachter. Kann zu Debugging-Zwecken protokolliert werden. Diese können Nutzern angezeigt werden. Eine gute Aktualisierung wäre „Parameter stimmen überein, in der Warteschlange zur Ausführung“ oder „Logdatei 2 von 5 geprüft“.
observerErrors[]

object (Status)

Optional. Ein Fehler im Untersuchungssystem, der einen Beobachter daran gehindert hat, eine bestimmte Beobachtung zu machen. Der Fehlerstring wird Nutzern angezeigt. Wiederholt, weil einem Betrachter möglicherweise mehrere Berechtigungen fehlen.

ObserverExecution

Der Status des Beobachters.

Enums
OBSERVER_EXECUTION_UNSPECIFIED Der Beobachterstatus ist nicht angegeben.
OBSERVER_EXECUTION_NOT_STARTED Die Untersuchung hat noch nicht begonnen.
OBSERVER_EXECUTION_RUNNING Die Prüfung läuft und dieser Observer kann ausgeführt werden oder wird ausgeführt.
OBSERVER_EXECUTION_COMPLETE Der Observer wurde ohne internen Fehler beendet.
OBSERVER_EXECUTION_FAILED Der Observer wurde versucht auszuführen, ist aber aufgrund eines Fehlers fehlgeschlagen. Dies bezieht sich auf eine bestimmte Komponente und kann in der Benutzeroberfläche gerendert werden, wenn die Beobachtung angezeigt wird, da sie eine sehr niedrige Priorität hat.
OBSERVER_EXECUTION_BLOCKED Der Beobachter ist blockiert und wartet auf eine Eingabe.
OBSERVER_EXECUTION_INVESTIGATION_BLOCKED Der Beobachter meldet einen Fehler, der die Untersuchung blockiert oder stark beeinträchtigt, z. B. CAIS oder deaktivierte Protokollierung. Sollte gut sichtbar auf der Benutzeroberfläche gerendert werden.
OBSERVER_EXECUTION_INVESTIGATION_DEGRADED Der Beobachter meldet einen Fehler, der die Untersuchung beeinträchtigt. Möglicherweise muss der Nutzer den Fehler eskalieren oder die Untersuchung nach Behebung der Ursache noch einmal ausführen.

AbsentObservation

Eine Kennung einer erforderlichen Beobachtung. Normalerweise ein Parameter, kann aber auch auf andere Fälle ausgeweitet werden.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld t. Es gibt mehr als eine Art von fehlenden Parametern. Für t ist nur einer der folgenden Werte zulässig:
param

string

Optional. Ein Runbook-Parameter.
generalMissingObservation

object (GeneralAbsentObservation)

Optional. Eine fehlende Beobachtung, die der Nutzer liefern könnte und die kein Runbook-Parameter ist.
pendingObservation

string

Optional. Eine Beobachtung, die noch nicht erstellt wurde und die ein Beobachter durch Ausführen erstellen sollte. Dadurch kann das System veranlasst werden, ein Runbook auszuführen.

GeneralAbsentObservation

Eine fehlende Beobachtung, die kein Runbook-Parameter ist.

JSON-Darstellung 
{
  "id": string,
  "title": string,
  "validationRegex": string
}
Felder
id

string

Optional. Die ID der fehlenden Beobachtung.
title

string

Optional. Der Titel, der in der Benutzeroberfläche angezeigt werden soll
validationRegex

string

Optional. Der reguläre Ausdruck, mit dem die Antwort übereinstimmen muss. Muss der Syntax für reguläre Ausdrücke in JavaScript entsprechen. Weitere Informationen finden Sie unter https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp#syntax.

ObserverLogEntry

Ein Logeintrag von einem Beobachter.

JSON-Darstellung 
{
  "logTime": string,
  "logMessage": string,
  "logSeverity": enum (LogSeverity),
  "data": {
    object
  },
  "sensitiveData": {
    object
  }
}
Felder
logTime

string (Timestamp format)

Erforderlich. Die Zeit, zu der das Log erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
logMessage

string

Erforderlich. Die für Menschen lesbare Nachricht.
logSeverity

enum (LogSeverity)

Erforderlich. Der Schweregrad der Lognachricht.
data

object (Struct format)

Optional. Alle zusätzlichen Daten, z. B. ein RPC-Fehler. Warnung: Wie beim Rest von „ObserverStatus“ kann der Inhalt dieses Felds zu Debuggingzwecken für Observer gelesen werden. Verwenden Sie für sensible Daten stattdessen sensitiveData.
sensitiveData

object (Struct format)

Optional. Alle zusätzlichen Daten, die vertrauliche Informationen über das untersuchte Projekt enthalten könnten. Dieses Feld wird unkenntlich gemacht, wenn der ObserverStatus zu Debugging-Zwecken gelesen wird.

LogSeverity

Der Schweregrad des im Logeintrag beschriebenen Ereignisses, ausgedrückt als einer der unten aufgeführten Standardschweregrade. Die Ebenen werden den aufgeführten numerischen Werten zugewiesen. Die Auswirkungen der Verwendung anderer numerischer Werte als der aufgeführten sind nicht definiert.

Sie können Logeinträge nach Schweregrad filtern. Der folgende Filterausdruck stimmt beispielsweise mit Logeinträgen mit den Schweregraden INFO, NOTICE und WARNING überein:

severity > DEBUG AND severity <= WARNING

Wenn Sie Logeinträge schreiben, sollten Sie andere Schweregradcodierungen einem dieser Standardgrade zuordnen. Sie können beispielsweise alle FINE-, FINER- und FINEST-Ebenen von Java LogSeverity.DEBUG zuordnen. Sie können den ursprünglichen Schweregrad in der Nutzlast des Logeintrags beibehalten.

Enums
DEFAULT (0) Dem Logeintrag ist kein Schweregrad zugewiesen.
DEBUG (100) Debug- oder Trace-Informationen.
INFO (200) Routineinformationen wie laufender Status oder Leistung.
NOTICE (300) Normale, aber wichtige Ereignisse wie Start, Herunterfahren oder eine Konfigurationsänderung.
WARNING (400) Warnereignisse können Probleme verursachen.
ERROR (500) Fehlerereignisse verursachen wahrscheinlich Probleme.
CRITICAL (600) Kritische Ereignisse verursachen schwerwiegendere Probleme oder Ausfälle.
ALERT (700) Eine Person muss sofort handeln.
EMERGENCY (800) Ein oder mehrere Systeme sind nicht nutzbar.

ClarificationNeeded

Eine vom System benötigte Klarstellung.

JSON-Darstellung 
{
  "runbookParameter": {
    object (RunbookParameter)
  },
  "generalMissingObservation": {
    object (GeneralAbsentObservation)
  },
  "parentObserverNames": [
    string
  ]
}
Felder
runbookParameter

object (RunbookParameter)

Optional. Das Ergebnis einer Klärung ist eine Beobachtung. Ein Runbook-Parameter, den der Nutzer angeben muss.
generalMissingObservation

object (GeneralAbsentObservation)

Optional. Eine fehlende Beobachtung, die kein Runbook-Parameter ist.
parentObserverNames[]

string

Optional. Die Anzeigenamen der Beobachter, die um diese Klarstellung gebeten haben. In der Benutzeroberfläche wird nach diesen Namen gruppiert.

RunbookParameter

Parametermetadaten für Runbooks, die von der diagnostischen Aufgabe aktualisiert werden.

JSON-Darstellung 
{
  "id": string,
  "displayName": string,
  "description": string,
  "exampleValues": [
    string
  ],
  "value": string,
  "associatedAssetTypes": [
    string
  ]
}
Felder
id

string

Optional. Name des Parameters.
displayName

string

Optional. Der Name des Parameters, der dem Nutzer angezeigt werden soll.
description

string

Optional. Die Beschreibung des Parameters.
exampleValues[]

string

Optional. Beispiele für den Parameterwert.
value

string

Optional. Der Wert des Parameters, falls verfügbar.
associatedAssetTypes[]

string

Optional. Falls vorhanden, eine Liste der Ressourcentypen, die dieser Parameter sein könnte. Beispiel: „compute.googleapis.com/Instance“.

Methoden

create

 Erstellt eine neue Untersuchung in einem angegebenen Projekt und an einem angegebenen Ort.

delete

 Löscht eine einzelne Prüfung.

get

 Ruft Details zu einer einzelnen Untersuchung ab.

getIamPolicy

 Ruft die Zugriffssteuerungsrichtlinie für eine Ressource ab.

list

 Listet Untersuchungen in einem angegebenen Projekt und an einem angegebenen Standort auf.

patch

 Aktualisiert die Parameter einer einzelnen Untersuchung.

setIamPolicy

 Legt die Zugriffskontrollrichtlinie für die angegebene Ressource fest.

testIamPermissions

 Gibt die Berechtigungen des Aufrufers für die angegebene Ressource zurück.