Log Service config Object
The log service setup configuration (the config object) is log service-specific. We will continue to add more log services to this list:
Azure Monitor
Request
POST https://api.fivetran.com/v1/external-logging
{
"group_id": "target_group_id",
"service": "azure_monitor_log",
"enabled": true,
"config": {
"workspace_id": "string",
"primary_key": "PASSWORD"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
workspace_id | The workspace ID. | |
primary_key | The primary key. |
For more information, see our Azure Monitor setup guide.
Amazon CloudWatch
Request
POST https://api.fivetran.com/v1/external-logging
{
"group_id": "target_group_id",
"service": "cloudwatch",
"enabled": true,
"config": {
"log_group_name": "string",
"role_arn": "string",
"external_id": "string",
"region": "string"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
log_group_name | The log group name. | |
role_arn | the role ARN. | |
external_id | The external ID. | |
region | The region. |
For more information, see our Amazon CloudWatch setup guide.
Datadog
Request
POST https://api.fivetran.com/v1/external-logging
{
"group_id": "target_group_id",
"service": "datadog_log",
"enabled": true,
"config": {
"hostname": "string",
"api_key": "PASSWORD",
"region": "EU"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
hostname | The host name. | |
api_key | The API key. | |
region | The region. Possible values: US1, US3, US5, EU. Default value:US1. |
For more information, see our Datadog setup guide.
Google Cloud Logging
Request
POST https://api.fivetran.com/v1/external-logging
{
"group_id": "target_group_id",
"service": "stackdriver",
"enabled": true,
"config": {
"project_id": "string"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
project_id | The project ID. |
For more information, see our Google Cloud Logging setup guide.
New Relic
Request
POST https://api.fivetran.com/v1/external-logging
{
"group_id": "target_group_id",
"service": "new_relic_log",
"enabled": true,
"config": {
"api_key": "PASSWORD",
"sub_domain": "EU"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
api_key | The API key. | |
sub_domain | The subdomain. Possible values: US, EU, FedRAMP. Default value: US. |
For more information, see our New Relic setup guide.
Splunk Logging
Request
POST https://api.fivetran.com/v1/external-logging
{
"group_id": "target_group_id",
"service": "splunkLog",
"enabled": true,
"config": {
"port": 0,
"host": "string",
"channel": "string",
"enable_ssl": true,
"token": "PASSWORD"
}
}
Config parameters
| Name | Description | Possible Values |
|---|---|---|
port | The port. | |
host | The host. | |
channel | The channel. | |
enable_ssl | The boolean specifying whether SSL is enabled. | |
token | The token. |
For more information, see our Splunk Logging setup guide.