Skip to content

Commit

Permalink
logscale: add documentation for plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffmahoney committed May 9, 2023
1 parent 2bef6fc commit 996555b
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/references/vql.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2680,6 +2680,50 @@
type: string
description: Level to log at (DEFAULT, WARN, ERROR, INFO).
category: basic
- name: logscale_upload
description: Upload rows to LogScale.
type: Plugin:
args:
- name: query
type: StoredQuery
description: Source for rows to upload.
required: true
- name: apibaseurl
type: string
description: The LogScale API base URL.
- name: ingest_token
type: string
description: LogScale Ingestion Token
- name: threads
type: int64
description: How many threads to use.
- name: http_timeout
type: int64
description: Timeout for HTTP requests to complete, in seconds (default: 10).
- name: max_retries
type: int64
description: Maximum number of retries before an upload is considered failed (default: 7200).
- name: root_ca
type: string
description: As a better alternative to skip_verify, allows root ca certs to be
added here.
- name: skip_verify
type: bool
description: 'Skip SSL verification(default: False).'
- name: batching_timeout_ms
type: int64
description: Timeout without new rows to upload batch in milliseconds (default: 3000).
- name: event_batch_size
type: int64
description: Number of rows to batch before uploading (default: 2000).
- name: tag_fields
type: string
description: Comma-separated list of fields to use as tags. The fields can be remapped using oldname=newname syntax.
- name: stats_interval
type: int64 description: Interval between posting statistics as output rows in seconds (default: 600).
- name: debug
type: bool
description: Enable verbose logging (default: false).
- name: lookupSID
description: Get information about the SID.
type: Function
Expand Down

0 comments on commit 996555b

Please sign in to comment.