sources

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

Overview

Name	sources
Type	Resource
Id	sumologic.collectors.sources

Fields

The following fields are returned by SELECT queries:

get_source_by_id

Name	Datatype	Description
id	integer	Source identifer.
name	string	Source name.
alive	boolean	Source alive.
automaticDateParsing	boolean	Source automaticDateParsing.
category	string	Source category.
cutoffTimestamp	integer	Source cutoffTimestamp.
denylist	array	Source denylist.
encoding	string	Source encoding.
fields	object	Source fields.
filters	array	Source filters.
forceTimeZone	boolean	Source forceTimeZone.
hashAlgorithm	string	Source hashAlgorithm.
hostName	string	Source hostName.
messagePerRequest	boolean	Source messagePerRequest.
multilineProcessingEnabled	boolean	Source multilineProcessingEnabled.
pathExpression	string	Source pathExpression.
sourceType	string	Source sourceType.
url	string	Source url.
useAutolineMatching	boolean	Source useAutolineMatching.

list_sources

Name	Datatype	Description
id	integer	Source identifer.
name	string	Source name.
alive	boolean	Source alive.
automaticDateParsing	boolean	Source automaticDateParsing.
category	string	Source category.
cutoffTimestamp	integer	Source cutoffTimestamp.
denylist	array	Source denylist.
encoding	string	Source encoding.
fields	object	Source fields.
filters	array	Source filters.
forceTimeZone	boolean	Source forceTimeZone.
hashAlgorithm	string	Source hashAlgorithm.
hostName	string	Source hostName.
messagePerRequest	boolean	Source messagePerRequest.
multilineProcessingEnabled	boolean	Source multilineProcessingEnabled.
pathExpression	string	Source pathExpression.
sourceType	string	Source sourceType.
url	string	Source url.
useAutolineMatching	boolean	Source useAutolineMatching.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_source_by_id	select	collectorId, sourceId, region		Gets information about a specified Collector and Source.
list_sources	select	collectorId, region		Gets information about all Sources for a specified Collector.
create_source	insert	collectorId, region		Creates a new Source for a Collector. See Use JSON to Configure Sources for required fields for the request JSON file.
delete_source	delete	collectorId, sourceId, region		Delete Source by ID
update_source	exec	collectorId, sourceId, region		Update a source

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
collectorId	string	Unique Collector identifier.
region	string	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)
sourceId	string	Unique Source identifier.

SELECT examples

get_source_by_id

Gets information about a specified Collector and Source.

SELECT
id,
name,
alive,
automaticDateParsing,
category,
cutoffTimestamp,
denylist,
encoding,
fields,
filters,
forceTimeZone,
hashAlgorithm,
hostName,
messagePerRequest,
multilineProcessingEnabled,
pathExpression,
sourceType,
url,
useAutolineMatching
FROM sumologic.collectors.sources
WHERE collectorId = '{{ collectorId }}' -- required
AND sourceId = '{{ sourceId }}' -- required
AND region = '{{ region }}' -- required
;

list_sources

Gets information about all Sources for a specified Collector.

SELECT
id,
name,
alive,
automaticDateParsing,
category,
cutoffTimestamp,
denylist,
encoding,
fields,
filters,
forceTimeZone,
hashAlgorithm,
hostName,
messagePerRequest,
multilineProcessingEnabled,
pathExpression,
sourceType,
url,
useAutolineMatching
FROM sumologic.collectors.sources
WHERE collectorId = '{{ collectorId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_source

Creates a new Source for a Collector. See Use JSON to Configure Sources for required fields for the request JSON file.

INSERT INTO sumologic.collectors.sources (
data__source,
collectorId,
region
)
SELECT 
'{{ source }}',
'{{ collectorId }}',
'{{ region }}'
RETURNING
id,
name,
alive,
automaticDateParsing,
category,
cutoffTimestamp,
denylist,
encoding,
fields,
filters,
forceTimeZone,
hashAlgorithm,
hostName,
messagePerRequest,
multilineProcessingEnabled,
pathExpression,
sourceType,
url,
useAutolineMatching
;

Manifest

# Description fields are for documentation purposes
- name: sources
  props:
    - name: collectorId
      value: string
      description: Required parameter for the sources resource.
    - name: region
      value: string
      description: Required parameter for the sources resource.
    - name: source
      value: object

DELETE examples

delete_source

Delete Source by ID

DELETE FROM sumologic.collectors.sources
WHERE collectorId = '{{ collectorId }}' --required
AND sourceId = '{{ sourceId }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

update_source

Update a source

EXEC sumologic.collectors.sources.update_source 
@collectorId='{{ collectorId }}' --required, 
@sourceId='{{ sourceId }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"id": {{ id }}, 
"name": "{{ name }}", 
"category": "{{ category }}", 
"hostName": "{{ hostName }}", 
"automaticDateParsing": {{ automaticDateParsing }}, 
"multilineProcessingEnabled": {{ multilineProcessingEnabled }}, 
"useAutolineMatching": {{ useAutolineMatching }}, 
"alive": {{ alive }}, 
"forceTimeZone": {{ forceTimeZone }}, 
"messagePerRequest": {{ messagePerRequest }}, 
"sourceType": "{{ sourceType }}", 
"encoding": "{{ encoding }}", 
"hashAlgorithm": "{{ hashAlgorithm }}", 
"url": "{{ url }}", 
"pathExpression": "{{ pathExpression }}", 
"denylist": "{{ denylist }}", 
"filters": "{{ filters }}", 
"fields": "{{ fields }}", 
"cutoffTimestamp": {{ cutoffTimestamp }}
}'
;