Smartsheet-Protokolle erfassen
In diesem Dokument wird beschrieben, wie Sie Smartsheet-Logs mit Google Cloud Storage in Google Security Operations aufnehmen.
Smartsheet ist eine Plattform für die Zusammenarbeit, die Unternehmen tabellenähnliches Projektmanagement, Aufgaben-Tracking und Workflow-Automatisierung bietet. Die Event Reporting API bietet Audit-Logs für mehr als 100 Ereignistypen, darunter Nutzeraktionen, Datenzugriff, Änderungen an Freigaben und administrative Vorgänge in Ihrer Smartsheet-Organisation.
Hinweis
Prüfen Sie, ob folgende Voraussetzungen erfüllt sind:
- Eine Google SecOps-Instanz
- Ein GCP-Projekt mit aktivierter Cloud Storage API
- Berechtigungen zum Erstellen und Verwalten von GCS-Buckets
- Berechtigungen zum Verwalten von IAM-Richtlinien für GCS-Buckets
- Berechtigungen zum Erstellen von Cloud Run-Funktionen, Pub/Sub-Themen und Cloud Scheduler-Jobs
- Ein Smartsheet Enterprise-Abo mit aktiviertem Add-on für die Ereignisberichterstellung
- Ein Smartsheet-Systemadministratorkonto mit API-Zugriff
Smartsheet API-Anmeldedaten erfassen
API-Zugriffstoken erstellen
- Melden Sie sich mit einem Systemadministratorkonto in Ihrem Smartsheet-Konto an.
- Wählen Sie unten in der linken Navigationsleiste Ihr Konto (Profilbild) aus und rufen Sie die Persönlichen Einstellungen auf.
- Rufen Sie den Tab API-Zugriff auf.
- Klicken Sie auf Generate new access token (Neues Zugriffstoken generieren).
- Geben Sie einen Namen für das Token ein (z. B.
SecOps SIEM Integration). - Klicken Sie auf OK.
Kopieren und speichern Sie das Zugriffstoken an einem sicheren Ort.
Berechtigungen prüfen
So prüfen Sie, ob das Konto die erforderlichen Berechtigungen hat:
- Melden Sie sich in Ihrem Smartsheet-Konto an.
- Gehen Sie zu Konto (Profilbild) > Persönliche Einstellungen > API-Zugriff.
- Wenn Sie die Seite API-Zugriffstokens verwalten sehen und Tokens generieren können, haben Sie die erforderlichen Berechtigungen.
- Wenn Sie nicht auf diese Optionen zugreifen können, wenden Sie sich an Ihren Smartsheet-Systemadministrator, um API-Zugriff zu erhalten.
API-Zugriff testen
Testen Sie Ihre Anmeldedaten, bevor Sie mit der Integration fortfahren:
# Replace with your actual access token SMARTSHEET_TOKEN="<your-access-token>" # Test Event Reporting API access curl -v -H "Authorization: Bearer ${SMARTSHEET_TOKEN}" \ "https://api.smartsheet.com/2.0/events?since=$(date -u -d '1 hour ago' +%Y-%m-%dT%H:%M:%SZ)&maxCount=10"
Wenn Sie diese Fehler sehen:
- HTTP 401: Prüfen Sie, ob das Zugriffstoken korrekt ist.
- HTTP 403: Prüfen Sie, ob das Konto Systemadministratorberechtigungen hat und das Add-on „Event Reporting“ für Ihr Abo aktiviert ist.
Google Cloud Storage-Bucket erstellen
- Gehen Sie zur Google Cloud Console.
- Wählen Sie Ihr Projekt aus oder erstellen Sie ein neues.
- Rufen Sie im Navigationsmenü Cloud Storage > Buckets auf.
- Klicken Sie auf Bucket erstellen.
Geben Sie die folgenden Konfigurationsdetails an:
Einstellung Wert Bucket benennen Geben Sie einen global eindeutigen Namen ein (z. B. smartsheet-audit-logs).Standorttyp Wählen Sie die Option, die am besten zu Ihren Anforderungen passt (Region, Dual-Region, Multi-Region). Standort Wählen Sie den Standort aus (z. B. us-central1).Speicherklasse Standard (empfohlen für Logs, auf die häufig zugegriffen wird) Zugriffssteuerung Einheitlich (empfohlen) Schutztools Optional: Objektversionsverwaltung oder Aufbewahrungsrichtlinie aktivieren Klicken Sie auf Erstellen.
Dienstkonto für die Cloud Run-Funktion erstellen
Die Cloud Run-Funktion benötigt ein Dienstkonto mit Berechtigungen zum Schreiben in den GCS-Bucket und zum Aufrufen durch Pub/Sub.
Erstellen Sie das Dienstkonto:
- Rufen Sie in der GCP Console die Seite IAM und Verwaltung > Dienstkonten auf.
- Klicken Sie auf Dienstkonto erstellen.
- Geben Sie die folgenden Konfigurationsdetails an:
- Dienstkontoname: Geben Sie
smartsheet-logs-saein. - Beschreibung des Dienstkontos: Geben Sie
Service account for Cloud Run function to collect Smartsheet audit logsein.
- Dienstkontoname: Geben Sie
- Klicken Sie auf Erstellen und fortfahren.
- Fügen Sie im Abschnitt Diesem Dienstkonto Zugriff auf das Projekt erteilen die folgenden Rollen hinzu:
- Klicken Sie auf Rolle auswählen.
- Suchen Sie nach Storage Object Admin und wählen Sie die Rolle aus.
- Klicken Sie auf + Weitere Rolle hinzufügen.
- Suchen Sie nach Cloud Run Invoker und wählen Sie die Rolle aus.
- Klicken Sie auf + Weitere Rolle hinzufügen.
- Suchen Sie nach Cloud Functions-Aufrufer und wählen Sie die Rolle aus.
- Klicken Sie auf Weiter.
- Klicken Sie auf Fertig.
Diese Rollen sind erforderlich für:
- Storage-Objekt-Administrator: Logs in den GCS-Bucket schreiben und Statusdateien verwalten
- Cloud Run-Aufrufer: Pub/Sub erlauben, die Funktion aufzurufen
- Cloud Functions-Invoker: Funktionsaufruf zulassen
IAM-Berechtigungen für den GCS-Bucket gewähren
Gewähren Sie dem Dienstkonto Schreibberechtigungen für den GCS-Bucket:
- Rufen Sie Cloud Storage > Buckets auf.
- Klicken Sie auf den Namen Ihres Buckets (z. B.
smartsheet-audit-logs). - Wechseln Sie zum Tab Berechtigungen.
- Klicken Sie auf Zugriff erlauben.
- Geben Sie die folgenden Konfigurationsdetails an:
- Hauptkonten hinzufügen: Geben Sie die E-Mail-Adresse des Dienstkontos ein (z. B.
smartsheet-logs-sa@PROJECT_ID.iam.gserviceaccount.com). - Rollen zuweisen: Wählen Sie Storage Object Admin aus.
- Hauptkonten hinzufügen: Geben Sie die E-Mail-Adresse des Dienstkontos ein (z. B.
- Klicken Sie auf Speichern.
Pub/Sub-Thema erstellen
Erstellen Sie ein Pub/Sub-Thema, in dem Cloud Scheduler Nachrichten veröffentlicht und das die Cloud Run-Funktion abonniert.
- Wechseln Sie in der GCP Console zu Pub/Sub > Themen.
- Klicken Sie auf Thema erstellen.
- Geben Sie die folgenden Konfigurationsdetails an:
- Themen-ID: Geben Sie
smartsheet-logs-triggerein. - Übernehmen Sie die anderen Einstellungen.
- Themen-ID: Geben Sie
- Klicken Sie auf Erstellen.
Cloud Run-Funktion zum Erfassen von Logs erstellen
Die Cloud Run-Funktion wird durch Pub/Sub-Nachrichten von Cloud Scheduler ausgelöst, um Logs aus der Smartsheet Event Reporting API abzurufen und in GCS zu schreiben.
- Rufen Sie in der GCP Console Cloud Run auf.
- Klicken Sie auf Dienst erstellen.
- Wählen Sie Funktion aus (Funktion mit einem Inline-Editor erstellen).
Geben Sie im Abschnitt Konfigurieren die folgenden Konfigurationsdetails an:
Einstellung Wert Dienstname smartsheet-logs-to-gcsRegion Wählen Sie die Region aus, die Ihrem GCS-Bucket entspricht (z. B. us-central1).Laufzeit Wählen Sie Python 3.12 oder höher aus. Im Abschnitt Trigger (optional):
- Klicken Sie auf + Trigger hinzufügen.
- Wählen Sie Cloud Pub/Sub aus.
- Wählen Sie unter Cloud Pub/Sub-Thema auswählen die Option
smartsheet-logs-triggeraus. - Klicken Sie auf Speichern.
Im Abschnitt Authentifizierung:
- Wählen Sie Authentifizierung erforderlich aus.
- Prüfen Sie Identity and Access Management (IAM).
Scrollen Sie nach unten und maximieren Sie Container, Netzwerk, Sicherheit.
Rufen Sie den Tab Sicherheit auf:
- Dienstkonto: Wählen Sie
smartsheet-logs-saaus.
- Dienstkonto: Wählen Sie
Rufen Sie den Tab Container auf:
- Klicken Sie auf Variablen und Secrets.
- Klicken Sie für jede Umgebungsvariable auf + Variable hinzufügen:
Variablenname Beispielwert GCS_BUCKETsmartsheet-audit-logsGCS_PREFIXsmartsheet/events/STATE_KEYsmartsheet/events/state.jsonSMARTSHEET_TOKEN<your-smartsheet-access-token>MAX_COUNT1000TIMEOUT30Scrollen Sie im Bereich Variablen und Secrets nach unten zu Anfragen:
- Zeitüberschreitung bei Anfrage: Geben Sie
600Sekunden (10 Minuten) ein.
- Zeitüberschreitung bei Anfrage: Geben Sie
Rufen Sie den Tab Einstellungen auf:
- Im Abschnitt Ressourcen:
- Arbeitsspeicher: Wählen Sie 512 MiB oder höher aus.
- CPU: Wählen Sie 1 aus.
- Im Abschnitt Ressourcen:
Im Abschnitt Versionsskalierung:
- Mindestanzahl von Instanzen: Geben Sie
0ein. - Maximale Anzahl von Instanzen: Geben Sie
100ein oder passen Sie den Wert an die erwartete Last an.
- Mindestanzahl von Instanzen: Geben Sie
Klicken Sie auf Erstellen.
Warten Sie ein bis zwei Minuten, bis der Dienst erstellt wurde.
Nachdem der Dienst erstellt wurde, wird der Inline-Code-Editor automatisch geöffnet.
Funktionscode hinzufügen
- Geben Sie main unter Funktionseinstiegspunkt ein.
Erstellen Sie im Inline-Code-Editor zwei Dateien:
Erste Datei: main.py:
import functions_framework from google.cloud import storage import json import os import urllib3 from datetime import datetime, timezone import uuid import gzip import io # Initialize HTTP client with timeouts http = urllib3.PoolManager( timeout=urllib3.Timeout(connect=5.0, read=30.0), retries=False, ) # Initialize Storage client storage_client = storage.Client() # Environment variables GCS_BUCKET = os.environ.get('GCS_BUCKET') GCS_PREFIX = os.environ.get('GCS_PREFIX', 'smartsheet/events/') STATE_KEY = os.environ.get('STATE_KEY', 'smartsheet/events/state.json') SMARTSHEET_TOKEN = os.environ.get('SMARTSHEET_TOKEN') MAX_COUNT = int(os.environ.get('MAX_COUNT', '1000')) TIMEOUT = int(os.environ.get('TIMEOUT', '30')) EVENTS_URL = "https://api.smartsheet.com/2.0/events" @functions_framework.cloud_event def main(cloud_event): """ Cloud Run function triggered by Pub/Sub to fetch Smartsheet Event Reporting audit logs and write to GCS. Args: cloud_event: CloudEvent object containing Pub/Sub message """ if not all([GCS_BUCKET, SMARTSHEET_TOKEN]): print('Error: Missing required environment variables') return try: bucket = storage_client.bucket(GCS_BUCKET) # Load state state = load_state(bucket, STATE_KEY) stream_position = state.get('stream_position') print(f'Fetching events from stream position: {stream_position or "latest"}') # Fetch events total_written = 0 has_more = True while has_more: events, new_position, more = fetch_events(stream_position) if events: write_chunk(bucket, events, datetime.now(timezone.utc)) total_written += len(events) if new_position: stream_position = new_position has_more = more and total_written < 50000 # Save state state['stream_position'] = stream_position save_state(bucket, STATE_KEY, state) print(f'Successfully processed {total_written} events') except Exception as e: print(f'Error processing logs: {str(e)}') raise def load_state(bucket, key): """Load state from GCS.""" try: blob = bucket.blob(key) if blob.exists(): state_data = blob.download_as_text() return json.loads(state_data) except Exception as e: print(f'Warning: Could not load state: {str(e)}') return {} def save_state(bucket, key, state): """Save state to GCS.""" try: state['updated_at'] = datetime.now(timezone.utc).isoformat() blob = bucket.blob(key) blob.upload_from_string( json.dumps(state), content_type='application/json' ) except Exception as e: print(f'Warning: Could not save state: {str(e)}') def write_chunk(bucket, items, ts): """Write log chunk to GCS as compressed NDJSON.""" key = f"{GCS_PREFIX}{ts:%Y/%m/%d}/smartsheet-events-{uuid.uuid4()}.json.gz" buf = io.BytesIO() with gzip.GzipFile(fileobj=buf, mode='w') as gz: for rec in items: gz.write((json.dumps(rec) + '\n').encode('utf-8')) buf.seek(0) blob = bucket.blob(key) blob.upload_from_file(buf, content_type='application/gzip') print(f'Wrote {len(items)} events to {key}') return key def fetch_events(stream_position): """ Fetch events from Smartsheet Event Reporting API. The API uses a streaming model with streamPosition for pagination. On first call (no streamPosition), it returns the current position without events. Subsequent calls return events since the position. Returns: Tuple of (events list, new stream position, has more data) """ headers = { 'Authorization': f'Bearer {SMARTSHEET_TOKEN}', 'Accept': 'application/json' } params = [f'maxCount={MAX_COUNT}'] if stream_position: params.append(f'streamPosition={stream_position}') url = f"{EVENTS_URL}?{'&'.join(params)}" response = http.request( 'GET', url, headers=headers, timeout=TIMEOUT ) if response.status == 429: retry_after = int(response.headers.get('Retry-After', '60')) print(f'Rate limited (429). Retry-After: {retry_after}s') import time time.sleep(min(retry_after, 120)) return fetch_events(stream_position) if response.status != 200: print(f'API request failed: {response.status}') response_text = response.data.decode('utf-8') print(f'Response body: {response_text}') raise Exception(f'Failed to fetch events: {response.status}') data = json.loads(response.data.decode('utf-8')) events = data.get('data', []) or [] new_position = data.get('nextStreamPosition') more_available = data.get('moreEventsAvailable', False) if events: print(f'Retrieved {len(events)} events') return events, new_position, more_availableZweite Datei: requirements.txt:
functions-framework==3.* google-cloud-storage==2.* urllib3>=2.0.0
Klicken Sie auf Bereitstellen, um die Funktion zu speichern und bereitzustellen.
Warten Sie, bis die Bereitstellung abgeschlossen ist (2–3 Minuten).
Cloud Scheduler-Job erstellen
Cloud Scheduler veröffentlicht in regelmäßigen Abständen Nachrichten im Pub/Sub-Thema und löst so die Cloud Run-Funktion aus.
- Rufen Sie in der GCP Console die Option Cloud Scheduler auf.
- Klicken Sie auf Job erstellen.
Geben Sie die folgenden Konfigurationsdetails an:
Einstellung Wert Name smartsheet-logs-schedule-15minRegion Wählen Sie dieselbe Region wie für die Cloud Run-Funktion aus. Frequenz */15 * * * *(alle 15 Minuten)Zeitzone Zeitzone auswählen (UTC empfohlen) Zieltyp Pub/Sub Thema smartsheet-logs-triggerauswählenInhalt der Nachricht {}(leeres JSON-Objekt)Klicken Sie auf Erstellen.
Optionen für die Häufigkeit des Zeitplans
Wählen Sie die Häufigkeit basierend auf dem Logvolumen und den Latenzanforderungen aus:
| Häufigkeit | Cron-Ausdruck | Anwendungsfall |
|---|---|---|
| Alle 5 Minuten | */5 * * * * |
Hohes Volumen, niedrige Latenz |
| Alle 15 Minuten | */15 * * * * |
Standard (empfohlen) |
| Stündlich | 0 * * * * |
Geringe Lautstärke |
| Alle 6 Stunden | 0 */6 * * * |
Batchverarbeitung |
Integration testen
- Suchen Sie in der Cloud Scheduler-Konsole nach Ihrem Job (z. B.
smartsheet-logs-schedule-15min). - Klicken Sie auf Ausführung erzwingen, um den Job manuell auszulösen.
- Warte einige Sekunden.
- Rufen Sie Cloud Run > Dienste auf.
- Klicken Sie auf den Funktionsnamen (
smartsheet-logs-to-gcs). - Klicken Sie auf den Tab Logs.
Prüfen Sie, ob die Funktion erfolgreich ausgeführt wurde. Achte dabei auf Folgendes:
Fetching events from stream position: <position> Retrieved X events Wrote X events to smartsheet/events/YYYY/MM/DD/smartsheet-events-UUID.json.gz Successfully processed X eventsRufen Sie Cloud Storage > Buckets auf.
Klicken Sie auf den Namen Ihres Buckets (
smartsheet-audit-logs).Rufen Sie den Präfixordner (
smartsheet/events/) auf.Prüfen Sie, ob eine neue
.json.gz-Datei mit dem aktuellen Zeitstempel erstellt wurde.
Wenn Sie Fehler in den Logs sehen:
- HTTP 401: Prüfen Sie das Smartsheet-Zugriffstoken in den Umgebungsvariablen.
- HTTP 403: Prüfen Sie, ob das Konto Systemadministratorberechtigungen hat und die Ereignisberichterstellung aktiviert ist.
- HTTP 429: Ratenbegrenzung – die Funktion wird automatisch mit Backoff wiederholt.
- Fehlende Umgebungsvariablen: Prüfen Sie, ob alle erforderlichen Variablen in der Cloud Run-Funktionskonfiguration festgelegt sind.
Google SecOps-Dienstkonto abrufen
Google SecOps verwendet ein eindeutiges Dienstkonto, um Daten aus Ihrem GCS-Bucket zu lesen. Sie müssen diesem Dienstkonto Zugriff auf Ihren Bucket gewähren.
Feed in Google SecOps konfigurieren, um Smartsheet-Logs aufzunehmen
- Rufen Sie die Einstellungen > Datenverwaltung > Feeds auf. Wenn Sie eine reine SIEM-Plattform verwenden, rufen Sie die Einstellungen > Feeds auf.
- Klicken Sie auf Neuen Feed hinzufügen.
- Klicken Sie auf Einzelnen Feed konfigurieren.
- Geben Sie im Feld Feedname einen Namen für den Feed ein, z. B.
Smartsheet Audit Logs. - Wählen Sie Google Cloud Storage V2 als Quelltyp aus.
- Wählen Sie Smartsheet als Protokolltyp aus.
Klicken Sie auf Dienstkonto abrufen. Eine eindeutige E-Mail-Adresse für das Dienstkonto wird angezeigt, z. B.:
chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.comKopieren Sie diese E-Mail-Adresse. Sie verwenden es in der nächsten Aufgabe.
Klicken Sie auf Weiter.
Geben Sie Werte für die folgenden Eingabeparameter an:
- Storage-Bucket-URL: Geben Sie den GCS-Bucket-URI mit dem Präfixpfad ein:
gs://smartsheet-audit-logs/smartsheet/events/Ersetzen Sie:
smartsheet-audit-logs: Der Name Ihres GCS-Buckets.smartsheet/events/: Präfixpfad, unter dem Logs gespeichert werden.
- Option zum Löschen der Quelle: Wählen Sie die gewünschte Löschoption aus:
- Nie: Nach Übertragungen werden keine Dateien gelöscht (empfohlen für Tests).
- Übertragene Dateien löschen: Dateien werden nach erfolgreicher Übertragung gelöscht.
- Übertragene Dateien und leere Verzeichnisse löschen: Dateien und leere Verzeichnisse werden nach erfolgreicher Übertragung gelöscht.
- Maximales Dateialter: Dateien einschließen, die in den letzten Tagen geändert wurden. Der Standardwert ist 180 Tage.
- Asset-Namespace: Der Asset-Namespace.
- Aufnahmelabels: Das Label, das auf die Ereignisse aus diesem Feed angewendet werden soll.
Klicken Sie auf Weiter.
Prüfen Sie die neue Feedkonfiguration auf dem Bildschirm Abschließen und klicken Sie dann auf Senden.
Dem Google SecOps-Dienstkonto IAM-Berechtigungen gewähren
Das Google SecOps-Dienstkonto benötigt die Rolle Storage-Objekt-Betrachter für Ihren GCS-Bucket.
- Rufen Sie Cloud Storage > Buckets auf.
- Klicken Sie auf den Namen Ihres Buckets (z. B.
smartsheet-audit-logs). - Wechseln Sie zum Tab Berechtigungen.
- Klicken Sie auf Zugriff erlauben.
- Geben Sie die folgenden Konfigurationsdetails an:
- Hauptkonten hinzufügen: Fügen Sie die E‑Mail-Adresse des Google SecOps-Dienstkontos ein.
- Rollen zuweisen: Wählen Sie Storage Object Viewer aus.
Klicken Sie auf Speichern.
UDM-Zuordnungstabelle
| Logfeld | UDM-Zuordnung | Logik |
|---|---|---|
accessLevel_label |
additional.fields |
Zusammengeführt |
appName_label |
additional.fields |
Zusammengeführt |
attachmentName_label |
additional.fields |
Zusammengeführt |
cellLinkSourceSheetId_label |
additional.fields |
Zusammengeführt |
dashboardName_label |
additional.fields |
Zusammengeführt |
folderName_label |
additional.fields |
Zusammengeführt |
formatType_label |
additional.fields |
Zusammengeführt |
includeAttachments_label |
additional.fields |
Zusammengeführt |
includeDiscussions_label |
additional.fields |
Zusammengeführt |
mergeType_label |
additional.fields |
Zusammengeführt |
rowCount_label |
additional.fields |
Zusammengeführt |
rowsMoved_label |
additional.fields |
Zusammengeführt |
sheetId_label |
additional.fields |
Zusammengeführt |
sheetName_label |
additional.fields |
Zusammengeführt |
sheetRowId_label |
additional.fields |
Zusammengeführt |
sourceFolderId_label |
additional.fields |
Zusammengeführt |
sourceObjectId_label |
additional.fields |
Zusammengeführt |
sourceSheetId_label |
additional.fields |
Zusammengeführt |
sourceType_label |
additional.fields |
Zusammengeführt |
tokenDisplayValue_label |
additional.fields |
Zusammengeführt |
tokenUserId_label |
additional.fields |
Zusammengeführt |
userId_label |
additional.fields |
Zusammengeführt |
workspaceId_label |
additional.fields |
Zusammengeführt |
additionalDetails.accessScopes |
metadata.description |
Direkt zugeordnet |
additionalDetails_tokenExpirationTimestamp |
metadata.event_timestamp |
Geparst als yyyy-MM-ddTHH:mm:ssZ |
eventTimestamp |
metadata.event_timestamp |
Geparst als yyyy-MM-ddTHH:mm:ssZ |
has_principal |
metadata.event_type |
Zugeordnet: true → USER_UNCATEGORIZED |
accessTokenName |
metadata.product_log_id |
Direkt zugeordnet |
eventId |
metadata.product_log_id |
Direkt zugeordnet |
additionalDetails.appClientId |
principal.user.userid |
Direkt zugeordnet |
requestUserId |
principal.user.userid |
Direkt zugeordnet |
object_id |
security_result.about.labels |
Zusammengeführt |
source_label |
security_result.about.labels |
Zusammengeführt |
object_type |
security_result.about.resource.attribute.labels |
Zusammengeführt |
action |
security_result.action_details |
Direkt zugeordnet |
userId |
target.user.userid |
Direkt zugeordnet |
| – | metadata.event_type |
Konstante: USER_UNCATEGORIZED |
Änderungsprotokoll
Änderungsprotokoll für diesen Parser ansehen
Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten