Skip to content
Pages in Reference

noust logdrain

Ship the logs of applications to Loki, Axiom, Fluent Bit, OTLP or a remote syslog.

Reference Updated View as Markdown
Shell
noust logdrain [OPTIONS] COMMAND [ARGS]...

Subcommands: add, disable, enable, list, remove, run, service, test

noust logdrain add

Make a destination, or change the one of that name.

Shell
noust logdrain add [OPTIONS] NAME

Arguments: name

Option What it does Default
--kind What the destination is.
--url Its address (not for syslog).
--tenant Loki: the tenant (X-Scope-OrgID).
--username Loki, http, otlp: the user, for basic authentication.
--auth http, otlp: how to authenticate.
--dataset Axiom: the dataset.
--region New Relic: where the account lives (us by default).
--transport Syslog: udp, tcp or tls.
--host Syslog: the receiver.
--port Syslog: its port (6514 for tls, 514 otherwise).
--facility Syslog: the facility, 0 to 23 (16 by default).
--ca Syslog over tls: the CA file the receiver must chain to.
--pin-sha256 Syslog over tls: the receiver's certificate pin.
--label Added to every line; repeat it.
--app Only this application; repeat it. Without any, all.
--token-stdin Read the token or password from standard input.
--disabled Make it, but do not ship to it yet.
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain disable

Stop shipping to a destination, keeping it.

Shell
noust logdrain disable [OPTIONS] NAME

Arguments: name

Option What it does Default
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain enable

Ship to a destination again.

Shell
noust logdrain enable [OPTIONS] NAME

Arguments: name

Option What it does Default
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain list

List the destinations and how each is doing.

Shell
noust logdrain list [OPTIONS]
Option What it does Default
--json Print the destinations as JSON.
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain remove

Remove a destination and its token.

Shell
noust logdrain remove [OPTIONS] NAME

Arguments: name

Option What it does Default
--yes, -y Do not ask for confirmation.
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain run

The shipper: read the logs of applications and send what is new, in a loop.

Shell
noust logdrain run [OPTIONS]
Option What it does Default
--once Do one cycle and exit.
--interval 5.0
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain service

The unit that runs the shipper.

Shell
noust logdrain service [OPTIONS] COMMAND [ARGS]...

Subcommands: install, remove, status

noust logdrain service install

Install the shipper's unit and start it.

Shell
noust logdrain service install [OPTIONS]
Option What it does Default
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain service remove

Stop the shipper and remove its unit. Destinations are kept.

Shell
noust logdrain service remove [OPTIONS]
Option What it does Default
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain service status

Say whether the shipper is installed and running.

Shell
noust logdrain service status [OPTIONS]
Option What it does Default
--json Print the state as JSON.
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust logdrain test

Send one line to a destination, and say what it answered.

Shell
noust logdrain test [OPTIONS] NAME

Arguments: name

Option What it does Default
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.

Search the documentation

Type to search every page.

↑ ↓ to move, Enter to open, Esc to close