Skip to content

Commit

Permalink
DXCDT-315: Refactor log streams create and update cmds (#599)
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiught authored Jan 12, 2023
1 parent 3bf0f9c commit 37e0321
Show file tree
Hide file tree
Showing 26 changed files with 1,901 additions and 783 deletions.
4 changes: 2 additions & 2 deletions docs/auth0_logs_streams.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ Auth0's log streaming service allows you to export tenant log events to a log ev
- [auth0 logs streams delete](auth0_logs_streams_delete.md) - Delete a log stream
- [auth0 logs streams list](auth0_logs_streams_list.md) - List all log streams
- [auth0 logs streams open](auth0_logs_streams_open.md) - Open the settings page of a log stream
- [auth0 logs streams show](auth0_logs_streams_show.md) - Show a log stream by Id
- [auth0 logs streams update](auth0_logs_streams_update.md) - Update a log stream
- [auth0 logs streams show](auth0_logs_streams_show.md) - Show a log stream by ID
- [auth0 logs streams update](auth0_logs_streams_update.md) - Update an existing log stream

81 changes: 8 additions & 73 deletions docs/auth0_logs_streams_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,79 +3,14 @@ layout: default
---
# auth0 logs streams create

Create a new log stream.
Log Streaming allows you to export your events in near real-time.

To create interactively, use `auth0 logs streams create` with no arguments.

To create non-interactively, supply the log stream name, type and other information through the flags.

## Usage
```
auth0 logs streams create [flags]
```

## Examples

```
auth0 logs streams create
# Custom Webhook
auth0 logs streams create -n mylogstream -t http --http-type application/json --http-format JSONLINES --http-auth 1343434
# Datadog
auth0 logs streams create -n mydatadog -t datadog --datadog-key 9999999 --datadog-id us
# EventBridge
auth0 logs streams create -n myeventbridge -t eventbridge --eventbridge-id 999999999999 --eventbridge-region us-east-1
# Splunk
auth0 logs streams create -n test-splunk -t splunk --splunk-domain demo.splunk.com --splunk-token 12a34ab5-c6d7-8901-23ef-456b7c89d0c1 --splunk-port 8080 --splunk-secure=true
```


## Flags

```
--datadog-id string The region in which datadog dashboard is created.
if you are in the datadog EU site ('app.datadoghq.eu'), the Region should be EU otherwise it should be US.
--datadog-key string Datadog API Key. To obtain a key, see the Datadog Authentication documentation (https://docs.datadoghq.com/api/latest/authentication).
--eventbridge-id string Id of the AWS account.
--eventbridge-region string The region in which eventbridge will be created.
--eventgrid-group string The name of the Azure resource group.
--eventgrid-id string Id of the Azure subscription.
--eventgrid-region string The region in which the Azure subscription is hosted.
--http-auth string HTTP Authorization header.
--http-endpoint string HTTP endpoint.
--http-format string HTTP Content-Format header. Possible values: jsonlines, jsonarray, jsonobject.
--http-type string HTTP Content-Type header. Possible values: application/json.
--json Output in json format.
-n, --name string Name of the log stream.
--splunk-domain string The domain name of the splunk instance.
--splunk-port string The port of the HTTP event collector.
--splunk-secure This should be set to 'false' when using self-signed certificates.
--splunk-token string Splunk event collector token.
--sumo-source string Generated URL for your defined HTTP source in Sumo Logic.
-t, --type string Type of the log stream. Possible values: http, eventbridge, eventgrid, datadog, splunk, sumo.
```


## InheritedFlags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 logs streams create](auth0_logs_streams_create.md) - Create a new log stream
- [auth0 logs streams delete](auth0_logs_streams_delete.md) - Delete a log stream
- [auth0 logs streams list](auth0_logs_streams_list.md) - List all log streams
- [auth0 logs streams open](auth0_logs_streams_open.md) - Open the settings page of a log stream
- [auth0 logs streams show](auth0_logs_streams_show.md) - Show a log stream by Id
- [auth0 logs streams update](auth0_logs_streams_update.md) - Update a log stream
## Commands

- [auth0 logs streams create datadog](auth0_logs_streams_create_datadog.md) - Create a new Datadog log stream
- [auth0 logs streams create eventbridge](auth0_logs_streams_create_eventbridge.md) - Create a new Amazon Event Bridge log stream
- [auth0 logs streams create eventgrid](auth0_logs_streams_create_eventgrid.md) - Create a new Azure Event Grid log stream
- [auth0 logs streams create http](auth0_logs_streams_create_http.md) - Create a new Custom Webhook log stream
- [auth0 logs streams create splunk](auth0_logs_streams_create_splunk.md) - Create a new Splunk log stream
- [auth0 logs streams create sumo](auth0_logs_streams_create_sumo.md) - Create a new Sumo Logic log stream

59 changes: 59 additions & 0 deletions docs/auth0_logs_streams_create_datadog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
layout: default
---
# auth0 logs streams create datadog

Build interactive dashboards and get alerted on critical issues.

To create interactively, use `auth0 logs streams create datadog` with no arguments.

To create non-interactively, supply the log stream name and other information through the flags.

## Usage
```
auth0 logs streams create datadog [flags]
```

## Examples

```
auth0 logs streams create datadog
auth0 logs streams create datadog --name <name>
auth0 logs streams create datadog --name <name> --region <region>
auth0 logs streams create datadog --name <name> --region <region> --api-key <api-key>
auth0 logs streams create datadog -n <name> -r <region> -k <api-key>
auth0 logs streams create datadog -n mylogstream -r eu -k 121233123455 --json
```


## Flags

```
-k, --api-key string Datadog API Key. To obtain a key, see the Datadog Authentication documentation (https://docs.datadoghq.com/api/latest/authentication).
--json Output in json format.
-n, --name string The name of the log stream.
-r, --region string The region in which the datadog dashboard is created.
If you are in the datadog EU site ('app.datadoghq.eu'), the Region should be EU otherwise it should be US.
```


## InheritedFlags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 logs streams create datadog](auth0_logs_streams_create_datadog.md) - Create a new Datadog log stream
- [auth0 logs streams create eventbridge](auth0_logs_streams_create_eventbridge.md) - Create a new Amazon Event Bridge log stream
- [auth0 logs streams create eventgrid](auth0_logs_streams_create_eventgrid.md) - Create a new Azure Event Grid log stream
- [auth0 logs streams create http](auth0_logs_streams_create_http.md) - Create a new Custom Webhook log stream
- [auth0 logs streams create splunk](auth0_logs_streams_create_splunk.md) - Create a new Splunk log stream
- [auth0 logs streams create sumo](auth0_logs_streams_create_sumo.md) - Create a new Sumo Logic log stream


58 changes: 58 additions & 0 deletions docs/auth0_logs_streams_create_eventbridge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
layout: default
---
# auth0 logs streams create eventbridge

Stream real-time Auth0 data to over 15 targets like AWS Lambda.

To create interactively, use `auth0 logs streams create eventbridge` with no arguments.

To create non-interactively, supply the log stream name and other information through the flags.

## Usage
```
auth0 logs streams create eventbridge [flags]
```

## Examples

```
auth0 logs streams create eventbridge
auth0 logs streams create eventbridge --name <name>
auth0 logs streams create eventbridge --name <name> --aws-id <aws-id>
auth0 logs streams create eventbridge --name <name> --aws-id <aws-id> --aws-region <aws-region>
auth0 logs streams create eventbridge -n <name> -i <aws-id> -r <aws-region>
auth0 logs streams create eventbridge -n mylogstream -i 999999999999 -r "eu-west-1" --json
```


## Flags

```
-i, --aws-id string ID of the AWS account.
-r, --aws-region string The AWS region in which eventbridge will be created, e.g. 'us-east-2'.
--json Output in json format.
-n, --name string The name of the log stream.
```


## InheritedFlags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 logs streams create datadog](auth0_logs_streams_create_datadog.md) - Create a new Datadog log stream
- [auth0 logs streams create eventbridge](auth0_logs_streams_create_eventbridge.md) - Create a new Amazon Event Bridge log stream
- [auth0 logs streams create eventgrid](auth0_logs_streams_create_eventgrid.md) - Create a new Azure Event Grid log stream
- [auth0 logs streams create http](auth0_logs_streams_create_http.md) - Create a new Custom Webhook log stream
- [auth0 logs streams create splunk](auth0_logs_streams_create_splunk.md) - Create a new Splunk log stream
- [auth0 logs streams create sumo](auth0_logs_streams_create_sumo.md) - Create a new Sumo Logic log stream


60 changes: 60 additions & 0 deletions docs/auth0_logs_streams_create_eventgrid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
layout: default
---
# auth0 logs streams create eventgrid

A single service for routing events from any source to destination.

To create interactively, use `auth0 logs streams create eventgrid` with no arguments.

To create non-interactively, supply the log stream name and other information through the flags.

## Usage
```
auth0 logs streams create eventgrid [flags]
```

## Examples

```
auth0 logs streams create eventgrid
auth0 logs streams create eventgrid --name <name>
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id>
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id> --azure-region <azure-region>
auth0 logs streams create eventgrid --name <name> --azure-id <azure-id> --azure-region <azure-region> --azure-group <azure-group>
auth0 logs streams create eventgrid -n <name> -i <azure-id> -r <azure-region> -g <azure-group>
auth0 logs streams create eventgrid -n mylogstream -i "b69a6835-57c7-4d53-b0d5-1c6ae580b6d5" -r northeurope -g "azure-logs-rg" --json
```


## Flags

```
-g, --azure-group string The name of the Azure resource group.
-i, --azure-id string Id of the Azure subscription.
-r, --azure-region string The region in which the Azure subscription is hosted.
--json Output in json format.
-n, --name string The name of the log stream.
```


## InheritedFlags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 logs streams create datadog](auth0_logs_streams_create_datadog.md) - Create a new Datadog log stream
- [auth0 logs streams create eventbridge](auth0_logs_streams_create_eventbridge.md) - Create a new Amazon Event Bridge log stream
- [auth0 logs streams create eventgrid](auth0_logs_streams_create_eventgrid.md) - Create a new Azure Event Grid log stream
- [auth0 logs streams create http](auth0_logs_streams_create_http.md) - Create a new Custom Webhook log stream
- [auth0 logs streams create splunk](auth0_logs_streams_create_splunk.md) - Create a new Splunk log stream
- [auth0 logs streams create sumo](auth0_logs_streams_create_sumo.md) - Create a new Sumo Logic log stream


62 changes: 62 additions & 0 deletions docs/auth0_logs_streams_create_http.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
layout: default
---
# auth0 logs streams create http

Specify a URL you'd like Auth0 to post events to.

To create interactively, use `auth0 logs streams create http` with no arguments.

To create non-interactively, supply the log stream name and other information through the flags.

## Usage
```
auth0 logs streams create http [flags]
```

## Examples

```
auth0 logs streams create http
auth0 logs streams create http --name <name>
auth0 logs streams create http --name <name> --endpoint <endpoint>
auth0 logs streams create http --name <name> --endpoint <endpoint> --type <type>
auth0 logs streams create http --name <name> --endpoint <endpoint> --type <type> --format <format>
auth0 logs streams create http --name <name> --endpoint <endpoint> --type <type> --format <format> --authorization <authorization>
auth0 logs streams create http -n <name> -e <endpoint> -t <type> -f <format> -a <authorization>
auth0 logs streams create http -n mylogstream -e "https://example.com/webhook/logs" -t "application/json" -f "JSONLINES" -a "AKIAXXXXXXXXXXXXXXXX" --json
```


## Flags

```
-a, --authorization string Sent in the HTTP "Authorization" header with each request.
-e, --endpoint string The HTTP endpoint to send streaming logs to.
-f, --format string The format of data sent over HTTP. Options are "JSONLINES", "JSONARRAY" or "JSONOBJECT"
--json Output in json format.
-n, --name string The name of the log stream.
-t, --type string The "Content-Type" header to send over HTTP. Common value is "application/json".
```


## InheritedFlags

```
--debug Enable debug mode.
--no-color Disable colors.
--no-input Disable interactivity.
--tenant string Specific tenant to use.
```


## Related Commands

- [auth0 logs streams create datadog](auth0_logs_streams_create_datadog.md) - Create a new Datadog log stream
- [auth0 logs streams create eventbridge](auth0_logs_streams_create_eventbridge.md) - Create a new Amazon Event Bridge log stream
- [auth0 logs streams create eventgrid](auth0_logs_streams_create_eventgrid.md) - Create a new Azure Event Grid log stream
- [auth0 logs streams create http](auth0_logs_streams_create_http.md) - Create a new Custom Webhook log stream
- [auth0 logs streams create splunk](auth0_logs_streams_create_splunk.md) - Create a new Splunk log stream
- [auth0 logs streams create sumo](auth0_logs_streams_create_sumo.md) - Create a new Sumo Logic log stream


Loading

0 comments on commit 37e0321

Please sign in to comment.