log_sinks

Creates, updates, deletes, gets or lists a log_sinks resource.

Overview

Name	log_sinks
Type	Resource
Id	digitalocean.databases.log_sinks

Fields

The following fields are returned by SELECT queries:

databases_get_logsink

A JSON object with a key of sink.

Name	Datatype	Description
sink	object

databases_list_logsink

A JSON object with a key of sinks.

Name	Datatype	Description
sink_id	string	A unique identifier for Logsink (example: dfcc9f57d86bf58e321c2c6c31c7a971be244ac7)
sink_name	string	The name of the Logsink (example: prod-logsink)
config
sink_type	string	(example: rsyslog)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
databases_get_logsink	select	database_cluster_uuid, logsink_id		To get a logsink for a database cluster, send a GET request to /v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.
databases_list_logsink	select	database_cluster_uuid		To list logsinks for a database cluster, send a GET request to /v2/databases/$DATABASE_ID/logsink.
databases_create_logsink	insert	database_cluster_uuid, data__sink_name, data__sink_type, data__config		To create logsink for a database cluster, send a POST request to /v2/databases/$DATABASE_ID/logsink.
databases_update_logsink	replace	database_cluster_uuid, logsink_id, data__config		To update a logsink for a database cluster, send a PUT request to /v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.
databases_delete_logsink	delete	database_cluster_uuid, logsink_id		To delete a logsink for a database cluster, send a DELETE request to /v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_cluster_uuid	string (uuid)	A unique identifier for a database cluster. (example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30)
logsink_id	string	A unique identifier for a logsink of a database cluster (example: 50484ec3-19d6-4cd3-b56f-3b0381c289a6)

SELECT examples

databases_get_logsink

To get a logsink for a database cluster, send a GET request to
/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

SELECT
sink
FROM digitalocean.databases.log_sinks
WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required
AND logsink_id = '{{ logsink_id }}' -- required;

databases_list_logsink

To list logsinks for a database cluster, send a GET request to
/v2/databases/$DATABASE_ID/logsink.

SELECT
sink_id,
sink_name,
config,
sink_type
FROM digitalocean.databases.log_sinks
WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required;

INSERT examples

databases_create_logsink

To create logsink for a database cluster, send a POST request to
/v2/databases/$DATABASE_ID/logsink.

INSERT INTO digitalocean.databases.log_sinks (
data__sink_name,
data__sink_type,
data__config,
database_cluster_uuid
)
SELECT 
'{{ sink_name }}' --required,
'{{ sink_type }}' --required,
'{{ config }}' --required,
'{{ database_cluster_uuid }}'
RETURNING
sink
;

Manifest

# Description fields are for documentation purposes
- name: log_sinks
  props:
    - name: database_cluster_uuid
      value: string (uuid)
      description: Required parameter for the log_sinks resource.
    - name: sink_name
      value: string
      description: >
        The name of the Logsink
        
    - name: sink_type
      value: string
      description: >
        Type of logsink integration.

- Use `datadog` for Datadog integration **only with MongoDB clusters**.
- For non-MongoDB clusters, use `rsyslog` for general syslog forwarding.
- Other supported types include `elasticsearch` and `opensearch`.

More details about the configuration can be found in the `config` property.

      valid_values: ['rsyslog', 'elasticsearch', 'opensearch', 'datadog']
    - name: config
      value: string

REPLACE examples

databases_update_logsink

To update a logsink for a database cluster, send a PUT request to
/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

REPLACE digitalocean.databases.log_sinks
SET 
data__config = '{{ config }}'
WHERE 
database_cluster_uuid = '{{ database_cluster_uuid }}' --required
AND logsink_id = '{{ logsink_id }}' --required
AND data__config = '{{ config }}' --required;

DELETE examples

databases_delete_logsink

To delete a logsink for a database cluster, send a DELETE request to
/v2/databases/$DATABASE_ID/logsink/$LOGSINK_ID.

DELETE FROM digitalocean.databases.log_sinks
WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' --required
AND logsink_id = '{{ logsink_id }}' --required;