Log Service
Represents an external logging service configured in your Fivetran account. Log services receive Fivetran log events and forward them to a third-party logging provider. You can configure a log service at the group level to capture logs for a specific group, or at the account level to capture logs across the entire account.
Resource attributes
The following attributes describe a log service configuration.
| Field name | Type | Description |
|---|---|---|
id | string, read-only | Unique identifier of the log service. |
service | string | The logging provider. Possible values: azure_monitor_log, cloudwatch, datadog_log, grafana_loki, new_relic_log, splunkLog, stackdriver. |
enabled | boolean | Indicates whether the log service is enabled and receiving log events. |
config | object | Service-specific configuration for the logging provider. The required fields vary by service type. |
status | object, read-only | Setup status of the log service. Present when a setup status exists for the log service. Absent for log services that have never had their status set. |
status.setup_state | string, read-only | Current setup state of the log service. Possible values: connected — log service is reachable and forwarding events; broken — configuration errors prevent log delivery; incomplete — setup has not been completed and log delivery is paused. Example: "setup_state": "connected". |
status.tasks | array, read-only | List of alerts describing issues with the log service configuration. Each task has code, message, and optional details fields. |
The following additional attributes are returned by create, update, and test endpoints.
| Field name | Type | Description |
|---|---|---|
setup_tests | array, read-only | Results of the most recent setup test run. Each entry contains title, status with values PASSED, SKIPPED, WARNING, FAILED, or JOB_FAILED, and optional message and details fields. |
The following fields are accepted in create and update request bodies.
| Field name | Type | Description |
|---|---|---|
run_setup_tests | boolean | When true, Fivetran runs setup tests immediately after creating or updating the log service. The test results are returned in the setup_tests field of the response. Defaults to false. |
Supported operations
| Category | Endpoint | Description |
|---|---|---|
| List | GET /v1/external-logging | Returns a paginated list of all group-level log services in the account. |
| Create group log service | POST /v1/external-logging | Creates a new log service for a group. |
| Retrieve group log service | GET /v1/external-logging/{logId} | Returns the details of a group-level log service. |
| Update group log service | PATCH /v1/external-logging/{logId} | Updates an existing group-level log service. |
| Delete group log service | DELETE /v1/external-logging/{logId} | Deletes a group-level log service. |
| Test group log service | POST /v1/external-logging/{logId}/test | Runs setup tests for a group-level log service. |
| Retrieve account log service | GET /v1/external-logging/account | Returns the account-level log service if one exists. |
| Create account log service | POST /v1/external-logging/account | Creates a new account-level log service. |
| Update account log service | PATCH /v1/external-logging/account | Updates the account-level log service. |
| Delete account log service | DELETE /v1/external-logging/account | Deletes the account-level log service. |
| Test account log service | POST /v1/external-logging/account/test | Runs setup tests for the account-level log service. |