output_graylog_streams

Creates, updates, deletes, gets or lists an output_graylog_streams resource.

Overview

Name	output_graylog_streams
Type	Resource
Id	ovh.dbaas_logs.output_graylog_streams

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
parent_stream_id	string (uuid)	Parent stream ID (wire: parentStreamId)
retention_id	string (uuid)	Retention ID (wire: retentionId)
stream_id	string (uuid)	Stream ID (wire: streamId)
can_alert	boolean	Indicates if the current user can create alert on the stream (wire: canAlert)
cold_storage_compression	string	Cold storage compression method (DEFLATED, GZIP, LZMA, ZSTD) (wire: coldStorageCompression)
cold_storage_content	string	ColdStorage content (ALL, GELF, PLAIN) (wire: coldStorageContent)
cold_storage_enabled	boolean	Is Cold storage enabled? (wire: coldStorageEnabled)
cold_storage_notify_enabled	boolean	Notify on new Cold storage archive (wire: coldStorageNotifyEnabled)
cold_storage_retention	integer	Cold storage retention in year (wire: coldStorageRetention)
created_at	string (date-time)	Stream creation (wire: createdAt)
description	string	Stream description
encryption_keys_ids	array	Encryption keys used to encrypt stream archives (wire: encryptionKeysIds)
iam	object	IAM resource metadata
indexing_current_size	integer	Indexing current size (in bytes) (wire: indexingCurrentSize)
indexing_enabled	boolean	Enable ES indexing (wire: indexingEnabled)
indexing_max_size	integer	Maximum indexing size (in GB) (wire: indexingMaxSize)
indexing_notify_enabled	boolean	If set, notify when size is near 80, 90 or 100 % of the maximum configured setting (wire: indexingNotifyEnabled)
is_editable	boolean	Indicates if you are allowed to edit entry (wire: isEditable)
nb_alert_condition	integer	Number of alert condition (wire: nbAlertCondition)
nb_archive	integer	Number of coldstored archives (wire: nbArchive)
nb_subscription	integer	Number of subscriptions targeting this stream (wire: nbSubscription)
pause_indexing_on_max_size	boolean	If set, pause indexing when maximum size is reach (wire: pauseIndexingOnMaxSize)
title	string	Stream name
updated_at	string (date-time)	Stream last update (wire: updatedAt)
web_socket_enabled	boolean	Enable Websocket (wire: webSocketEnabled)

list

Graylog stream

Name	Datatype	Description
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
parent_stream_id	string (uuid)	Parent stream ID (wire: parentStreamId)
retention_id	string (uuid)	Retention ID (wire: retentionId)
stream_id	string (uuid)	Stream ID (wire: streamId)
can_alert	boolean	Indicates if the current user can create alert on the stream (wire: canAlert)
cold_storage_compression	string	Cold storage compression method (DEFLATED, GZIP, LZMA, ZSTD) (wire: coldStorageCompression)
cold_storage_content	string	ColdStorage content (ALL, GELF, PLAIN) (wire: coldStorageContent)
cold_storage_enabled	boolean	Is Cold storage enabled? (wire: coldStorageEnabled)
cold_storage_notify_enabled	boolean	Notify on new Cold storage archive (wire: coldStorageNotifyEnabled)
cold_storage_retention	integer	Cold storage retention in year (wire: coldStorageRetention)
created_at	string (date-time)	Stream creation (wire: createdAt)
description	string	Stream description
encryption_keys_ids	array	Encryption keys used to encrypt stream archives (wire: encryptionKeysIds)
iam	object	IAM resource metadata
indexing_current_size	integer	Indexing current size (in bytes) (wire: indexingCurrentSize)
indexing_enabled	boolean	Enable ES indexing (wire: indexingEnabled)
indexing_max_size	integer	Maximum indexing size (in GB) (wire: indexingMaxSize)
indexing_notify_enabled	boolean	If set, notify when size is near 80, 90 or 100 % of the maximum configured setting (wire: indexingNotifyEnabled)
is_editable	boolean	Indicates if you are allowed to edit entry (wire: isEditable)
nb_alert_condition	integer	Number of alert condition (wire: nbAlertCondition)
nb_archive	integer	Number of coldstored archives (wire: nbArchive)
nb_subscription	integer	Number of subscriptions targeting this stream (wire: nbSubscription)
pause_indexing_on_max_size	boolean	If set, pause indexing when maximum size is reach (wire: pauseIndexingOnMaxSize)
title	string	Stream name
updated_at	string (date-time)	Stream last update (wire: updatedAt)
web_socket_enabled	boolean	Enable Websocket (wire: webSocketEnabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, stream_id		Returns the data stream.
list	select	service_name	iam_tags, x_pagination_mode	Returns the data streams of the Logs Data Platform service.
create	insert	service_name, description, title		Creates a data stream on the Logs Data Platform service.
update	update	service_name, stream_id, description, title		Updates the data stream.
delete	delete	service_name, stream_id		Deletes the data stream.

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
service_name	string	Service name (wire: serviceName)
stream_id	string (uuid)	Stream ID (wire: streamId)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the data stream.

SELECT
cluster_id,
parent_stream_id,
retention_id,
stream_id,
can_alert,
cold_storage_compression,
cold_storage_content,
cold_storage_enabled,
cold_storage_notify_enabled,
cold_storage_retention,
created_at,
description,
encryption_keys_ids,
iam,
indexing_current_size,
indexing_enabled,
indexing_max_size,
indexing_notify_enabled,
is_editable,
nb_alert_condition,
nb_archive,
nb_subscription,
pause_indexing_on_max_size,
title,
updated_at,
web_socket_enabled
FROM ovh.dbaas_logs.output_graylog_streams
WHERE service_name = '{{ service_name }}' -- required
AND stream_id = '{{ stream_id }}' -- required
;

list

Returns the data streams of the Logs Data Platform service.

SELECT
cluster_id,
parent_stream_id,
retention_id,
stream_id,
can_alert,
cold_storage_compression,
cold_storage_content,
cold_storage_enabled,
cold_storage_notify_enabled,
cold_storage_retention,
created_at,
description,
encryption_keys_ids,
iam,
indexing_current_size,
indexing_enabled,
indexing_max_size,
indexing_notify_enabled,
is_editable,
nb_alert_condition,
nb_archive,
nb_subscription,
pause_indexing_on_max_size,
title,
updated_at,
web_socket_enabled
FROM ovh.dbaas_logs.output_graylog_streams
WHERE service_name = '{{ service_name }}' -- required
AND iam_tags = '{{ iam_tags }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates a data stream on the Logs Data Platform service.

INSERT INTO ovh.dbaas_logs.output_graylog_streams (
cold_storage_compression,
cold_storage_content,
cold_storage_enabled,
cold_storage_notify_enabled,
cold_storage_retention,
description,
encryption_keys_ids,
indexing_enabled,
indexing_max_size,
indexing_notify_enabled,
parent_stream_id,
pause_indexing_on_max_size,
retention_id,
title,
web_socket_enabled,
service_name
)
SELECT 
'{{ cold_storage_compression }}',
'{{ cold_storage_content }}',
{{ cold_storage_enabled }},
{{ cold_storage_notify_enabled }},
{{ cold_storage_retention }},
'{{ description }}' /* required */,
'{{ encryption_keys_ids }}',
{{ indexing_enabled }},
{{ indexing_max_size }},
{{ indexing_notify_enabled }},
'{{ parent_stream_id }}',
{{ pause_indexing_on_max_size }},
'{{ retention_id }}',
'{{ title }}' /* required */,
{{ web_socket_enabled }},
'{{ service_name }}'
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: output_graylog_streams
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the output_graylog_streams resource.
  - name: cold_storage_compression
    value: "{{ cold_storage_compression }}"
    description: |
      Cold storage compression
    valid_values: ['DEFLATED', 'GZIP', 'LZMA', 'ZSTD']
  - name: cold_storage_content
    value: "{{ cold_storage_content }}"
    description: |
      Cold storage archive content
    valid_values: ['ALL', 'GELF', 'PLAIN']
  - name: cold_storage_enabled
    value: {{ cold_storage_enabled }}
    description: |
      Cold storage enabled
  - name: cold_storage_notify_enabled
    value: {{ cold_storage_notify_enabled }}
    description: |
      Cold storage notify enabled
  - name: cold_storage_retention
    value: {{ cold_storage_retention }}
    description: |
      Cold storage retention time
  - name: description
    value: "{{ description }}"
    description: |
      Description
  - name: encryption_keys_ids
    value:
      - "{{ encryption_keys_ids }}"
    description: |
      Encryption keys used to encrypt stream archives
  - name: indexing_enabled
    value: {{ indexing_enabled }}
    description: |
      ES indexing enabled
  - name: indexing_max_size
    value: {{ indexing_max_size }}
    description: |
      Maximum indexing size (in GB)
  - name: indexing_notify_enabled
    value: {{ indexing_notify_enabled }}
    description: |
      If set, notify when size is near 80, 90 or 100 % of the maximum configured setting
  - name: parent_stream_id
    value: "{{ parent_stream_id }}"
    description: |
      Parent stream ID
  - name: pause_indexing_on_max_size
    value: {{ pause_indexing_on_max_size }}
    description: |
      If set, pause indexing when maximum size is reach
  - name: retention_id
    value: "{{ retention_id }}"
    description: |
      Retention ID
  - name: title
    value: "{{ title }}"
    description: |
      Title
  - name: web_socket_enabled
    value: {{ web_socket_enabled }}
    description: |
      Web Socket enabled

UPDATE examples

update

Updates the data stream.

UPDATE ovh.dbaas_logs.output_graylog_streams
SET 
cold_storage_compression = '{{ cold_storage_compression }}',
cold_storage_content = '{{ cold_storage_content }}',
cold_storage_enabled = {{ cold_storage_enabled }},
cold_storage_notify_enabled = {{ cold_storage_notify_enabled }},
cold_storage_retention = {{ cold_storage_retention }},
description = '{{ description }}',
encryption_keys_ids = '{{ encryption_keys_ids }}',
indexing_enabled = {{ indexing_enabled }},
indexing_max_size = {{ indexing_max_size }},
indexing_notify_enabled = {{ indexing_notify_enabled }},
pause_indexing_on_max_size = {{ pause_indexing_on_max_size }},
title = '{{ title }}',
web_socket_enabled = {{ web_socket_enabled }}
WHERE 
service_name = '{{ service_name }}' --required
AND stream_id = '{{ stream_id }}' --required
AND description = '{{ description }}' --required
AND title = '{{ title }}' --required
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at;

DELETE examples

delete

Deletes the data stream.

DELETE FROM ovh.dbaas_logs.output_graylog_streams
WHERE service_name = '{{ service_name }}' --required
AND stream_id = '{{ stream_id }}' --required
;