Resource Source in pulumi-logtail.
Pulumi type: logtail:index/source:Source.
name is the Pulumi resource name. Nested object fields are documented under that object. They are not arguments of this resource.
Example#
Only required arguments are set. A string in angle brackets stands in for that argument. Any other value is an option or example written in the SDK description.
Arguments#
| Property | Type | Required | Description |
|---|---|---|---|
blockedMetrics | string[] | no | Metric names to mark as spam (one entry per metric). Listed metrics are rejected during ingestion and not billed. |
codeMappingSourceRoot | string | no | Source code root path that replaces the stack trace root prefix. Used to map container or build paths to the corresponding repository paths for git blame. |
codeMappingStackRoot | string | no | Stack trace root path prefix to match. When a stack trace file starts with this prefix, it will be replaced with the source code root to map to the correct repository path. |
customBucket | SourceCustomBucket (input) | no | Optional custom S3-compatible bucket configuration for the source. Can only be set when creating the source and cannot be added, changed, or removed afterwards - recreate the source to use a different bucket. Better Stack validates the credentials by writing and reading a test object in the bucket during creation. |
dataRegion | string | no | Data region or private cluster name to create the source in. Permitted values for most plans are: 'usWest', 'germany', 'singapore'. This value can only be set at creation time and cannot be changed afterwards. The API returns the specific cluster name, which may differ from the value you provide (for example, 'germany' may read back as 'eu-nbg-2').\ When importing an existing source, leave 'dataRegion' unset in your configuration - Terraform reads it from the API. Pinning it to an identifier that differs from the stored cluster name produces a spurious 'dataRegion' cannot be changed after source is created' error. |
ingestingPaused | boolean | no | This property allows you to temporarily pause data ingesting for this source (e.g., when you are reaching your plan's usage quota and you want to prioritize some sources over others). |
liveTailPattern | string | no | Freeform text template for formatting Live tail output with columns wrapped in {column} brackets. Example: "PID: {message_json.pid} {level} {message}" |
logsRetention | number | no | Data retention for logs in days. There might be additional charges for longer retention. |
metricsRetention | number | no | Data retention for metrics in days. There might be additional charges for longer retention. |
name | string | no | The name of this source. |
platform | string | yes | The platform of this source. This value can be set only when you're creating a new source. You can't update this value later. Valid values are: - apache2 - aws - awsCloudwatch - awsEcs - awsElb - awsFargate - azure - azureLogs - cloudflareLogpush - cloudflarePrometheusExporter - cloudflareWorker - datadogAgent - digitalocean - docker - dokku - dotnet - elasticsearch - erlang - fastly - filebeat - flights - fluentbit - fluentd - flyIo - gcp - go - googleCloudPubsub - haproxy - heroku - http - java - javascript - kubernetes - logstash - minio - mongodb - mysql - nginx - openTelemetry - php - postgresql - prometheus - prometheusScrape - python - rabbitmq - redis - render - rsyslog - ruby - syslog-ng - traefik - ubuntu - vector - vercelIntegration - winlogbeat |
scrapeFrequencySecs | number | no | For scrape platform types, how often to scrape the URLs. |
scrapeRequestBasicAuthPassword | string | no | Basic auth password for scraping. |
scrapeRequestBasicAuthUser | string | no | Basic auth username for scraping. |
scrapeRequestHeaders | { [key: string]: string }[] | no | An array of request headers, each containing name and value fields. |
scrapeUrls | string[] | no | For scrape platform types, the set of urls to scrape. |
skipSslVerify | boolean | no | Should the scraper skip SSL certificate verification? Enable for endpoints with self-signed or invalid certificates. |
sourceGroupId | number | no | The ID of the source group this source belongs to. |
teamName | string | no | Used to specify the team the resource should be created in when using global tokens. You can't update this value later. |
vrlTransformationLogs | string | no | VRL transformation applied to logs on Better Stack's servers during ingestion. Leave unset to keep the transformation unmanaged (reading back whatever is configured, including platform defaults); set to an empty string to remove it. Read more about VRL transformations. |
vrlTransformationSpans | string | no | VRL transformation applied to traces (spans) on Better Stack's servers during ingestion. Leave unset to keep the transformation unmanaged; set to an empty string to remove it. Read more about VRL transformations. |
Outputs#
Computed outputs are produced by the provider. They are not constructor arguments.
| Property | Type | Computed | Description |
|---|---|---|---|
blockedMetrics | string[] | no | Metric names to mark as spam (one entry per metric). Listed metrics are rejected during ingestion and not billed. |
codeMappingSourceRoot | string | no | Source code root path that replaces the stack trace root prefix. Used to map container or build paths to the corresponding repository paths for git blame. |
codeMappingStackRoot | string | no | Stack trace root path prefix to match. When a stack trace file starts with this prefix, it will be replaced with the source code root to map to the correct repository path. |
createdAt | string | yes | The time when this monitor group was created. |
customBucket | SourceCustomBucket (output) | no | Optional custom S3-compatible bucket configuration for the source. Can only be set when creating the source and cannot be added, changed, or removed afterwards - recreate the source to use a different bucket. Better Stack validates the credentials by writing and reading a test object in the bucket during creation. |
dataRegion | string | no | Data region or private cluster name to create the source in. Permitted values for most plans are: 'usWest', 'germany', 'singapore'. This value can only be set at creation time and cannot be changed afterwards. The API returns the specific cluster name, which may differ from the value you provide (for example, 'germany' may read back as 'eu-nbg-2').\ When importing an existing source, leave 'dataRegion' unset in your configuration - Terraform reads it from the API. Pinning it to an identifier that differs from the stored cluster name produces a spurious 'dataRegion' cannot be changed after source is created' error. |
ingestingHost | string | yes | The host where the logs or metrics should be sent. See documentation for your specific source platform for details. |
ingestingPaused | boolean | no | This property allows you to temporarily pause data ingesting for this source (e.g., when you are reaching your plan's usage quota and you want to prioritize some sources over others). |
liveTailPattern | string | no | Freeform text template for formatting Live tail output with columns wrapped in {column} brackets. Example: "PID: {message_json.pid} {level} {message}" |
logsRetention | number | no | Data retention for logs in days. There might be additional charges for longer retention. |
metricsRetention | number | no | Data retention for metrics in days. There might be additional charges for longer retention. |
name | string | no | The name of this source. |
platform | string | no | The platform of this source. This value can be set only when you're creating a new source. You can't update this value later. Valid values are: - apache2 - aws - awsCloudwatch - awsEcs - awsElb - awsFargate - azure - azureLogs - cloudflareLogpush - cloudflarePrometheusExporter - cloudflareWorker - datadogAgent - digitalocean - docker - dokku - dotnet - elasticsearch - erlang - fastly - filebeat - flights - fluentbit - fluentd - flyIo - gcp - go - googleCloudPubsub - haproxy - heroku - http - java - javascript - kubernetes - logstash - minio - mongodb - mysql - nginx - openTelemetry - php - postgresql - prometheus - prometheusScrape - python - rabbitmq - redis - render - rsyslog - ruby - syslog-ng - traefik - ubuntu - vector - vercelIntegration - winlogbeat |
scrapeFrequencySecs | number | no | For scrape platform types, how often to scrape the URLs. |
scrapeRequestBasicAuthPassword | string | no | Basic auth password for scraping. |
scrapeRequestBasicAuthUser | string | no | Basic auth username for scraping. |
scrapeRequestHeaders | { [key: string]: string }[] | no | An array of request headers, each containing name and value fields. |
scrapeUrls | string[] | no | For scrape platform types, the set of urls to scrape. |
skipSslVerify | boolean | no | Should the scraper skip SSL certificate verification? Enable for endpoints with self-signed or invalid certificates. |
sourceGroupId | number | no | The ID of the source group this source belongs to. |
tableName | string | yes | The table name generated for this source. |
teamId | string | yes | The team ID for this resource. Can be used with tableName in Query API. |
teamName | string | no | Used to specify the team the resource should be created in when using global tokens. You can't update this value later. |
token | string | yes | The token of this source. This token is used to identify and route the data you will send to Better Stack. |
updatedAt | string | yes | The time when this monitor group was updated. |
vrlTransformationLogs | string | no | VRL transformation applied to logs on Better Stack's servers during ingestion. Leave unset to keep the transformation unmanaged (reading back whatever is configured, including platform defaults); set to an empty string to remove it. Read more about VRL transformations. |
vrlTransformationSpans | string | no | VRL transformation applied to traces (spans) on Better Stack's servers during ingestion. Leave unset to keep the transformation unmanaged; set to an empty string to remove it. Read more about VRL transformations. |
SourceCustomBucket (input)#
Input object SourceCustomBucket. Fields below belong to this object, not to the parent.
| Property | Type | Required | Description |
|---|---|---|---|
accessKeyId | string | yes | Access key ID |
endpoint | string | yes | Bucket endpoint including the bucket name, e.g. https://s3.us-east-1.amazonaws.com/my-bucket or https://my-bucket.s3.us-east-1.amazonaws.com. |
keepDataAfterRetention | boolean | no | Whether we should keep data in the bucket after the retention period. |
name | string | no | Bucket name derived from endpoint. Deprecated - do not set this attribute. |
secretAccessKey | string | yes | Secret access key |
SourceCustomBucket (output)#
Output object SourceCustomBucket. Fields below belong to this object.
| Property | Type | Always present | Description |
|---|---|---|---|
accessKeyId | string | yes | Access key ID |
endpoint | string | yes | Bucket endpoint including the bucket name, e.g. https://s3.us-east-1.amazonaws.com/my-bucket or https://my-bucket.s3.us-east-1.amazonaws.com. |
keepDataAfterRetention | boolean | no | Whether we should keep data in the bucket after the retention period. |
name | string | yes | Bucket name derived from endpoint. Deprecated - do not set this attribute. |
secretAccessKey | string | yes | Secret access key |