# noust logdrain

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

```bash
noust logdrain [OPTIONS] COMMAND [ARGS]...
```

Subcommands: [`add`](#noust-logdrain-add), [`disable`](#noust-logdrain-disable), [`enable`](#noust-logdrain-enable), [`list`](#noust-logdrain-list), [`remove`](#noust-logdrain-remove), [`run`](#noust-logdrain-run), [`service`](#noust-logdrain-service), [`test`](#noust-logdrain-test)

## noust logdrain add

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

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
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.

```bash
noust logdrain service [OPTIONS] COMMAND [ARGS]...
```

Subcommands: [`install`](#noust-logdrain-service-install), [`remove`](#noust-logdrain-service-remove), [`status`](#noust-logdrain-service-status)

## noust logdrain service install

Install the shipper's unit and start it.

```bash
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.

```bash
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.

```bash
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.

```bash
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. |  |