Crear flujos de registros

Crear un flujo de registros.

Tipos de flujo de registros

El valor de type del flujo de registros que se crea determina las propiedades requeridas en la carga útil sink.

Flujo HTTP

Para un flujo http, las propiedades de sink se muestran en la carga útil siguiente.

Solicitud:

{
  "name": "string",
  "type": "http",
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONLINES|JSONARRAY",
    "httpAuthorization": "string"
  }
}

Respuesta:

{
  "id": "string",
  "name": "string",
  "type": "http",
  "status": "active",
  "sink": {
    "httpEndpoint": "string",
    "httpContentType": "string",
    "httpContentFormat": "JSONLINES|JSONARRAY",
    "httpAuthorization": "string"
  }
}

Flujo de Amazon EventBridge

Para un flujo eventbridge, las propiedades de sink se muestran en la carga útil siguiente.

Solicitud:

{
  "name": "string",
  "type": "eventbridge",
  "sink": {
    "awsRegion": "string",
    "awsAccountId": "string"
  }
}

La respuesta incluirá un campo adicional, awsPartnerEventSource, en sink:

Respuesta:

{
  "id": "string",
  "name": "string",
  "type": "eventbridge",
  "status": "active",
  "sink": {
    "awsAccountId": "string",
    "awsRegion": "string",
    "awsPartnerEventSource": "string"
  }
}

Flujo de Azure Event Grid

Para un flujo Azure Event Grid, las propiedades de sink se muestran en la carga útil siguiente.

Solicitud:

{
  "name": "string",
  "type": "eventgrid",
  "sink": {
    "azureSubscriptionId": "string",
    "azureResourceGroup": "string",
    "azureRegion": "string"
  }
}

Respuesta:

{
  "id": "string",
  "name": "string",
  "type": "http",
  "status": "active",
  "sink": {
    "azureSubscriptionId": "string",
    "azureResourceGroup": "string",
    "azureRegion": "string",
    "azurePartnerTopic": "string"
  }
}

Flujo de Datadog

Para un flujo Datadog, las propiedades de sink se muestran en la carga útil siguiente.

Solicitud:

{
  "name": "string",
  "type": "datadog",
  "sink": {
    "datadogRegion": "string",
    "datadogApiKey": "string"
  }
}

Respuesta:

{
  "id": "string",
  "name": "string",
  "type": "datadog",
  "status": "active",
  "sink": {
    "datadogRegion": "string",
    "datadogApiKey": "string"
  }
}

Flujo de Splunk

Para un flujo Splunk, las propiedades de sink se muestran en la carga útil siguiente.

Solicitud:

{
  "name": "string",
  "type": "splunk",
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}

Respuesta:

{
  "id": "string",
  "name": "string",
  "type": "splunk",
  "status": "active",
  "sink": {
    "splunkDomain": "string",
    "splunkToken": "string",
    "splunkPort": "string",
    "splunkSecure": "boolean"
  }
}

Flujo de Sumo Logic

Para un flujo Sumo Logic, las propiedades de sink se muestran en la carga útil siguiente.

Solicitud:

{
  "name": "string",
  "type": "sumo",
  "sink": {
    "sumoSourceAddress": "string"
  }
}

Respuesta:

{
  "id": "string",
  "name": "string",
  "type": "sumo",
  "status": "active",
  "sink": {
    "sumoSourceAddress": "string"
  }
}

POST https://{tenantDomain}/api/v2/log-streams

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.CreateLogStreamRequestContent{
        CreateLogStreamHttpRequestBody: &management.CreateLogStreamHttpRequestBody{
            Type: management.LogStreamHttpEnum(
                "http",
            ),
            Sink: &management.LogStreamHttpSink{
                HttpEndpoint: "httpEndpoint",
            },
        },
    }
    client.LogStreams.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logStreams.create({
        type: "http",
        sink: {
            httpEndpoint: "httpEndpoint",
        },
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.logStreams.create({
        type: "http",
        sink: {
            httpEndpoint: "httpEndpoint",
        },
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/log-streams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  },
  "type": "http",
  "filters": [
    {
      "type": "category"
    }
  ],
  "isPriority": true,
  "name": "<string>",
  "startFrom": "2021-03-01T19:57:29.532Z"
}
'

import requests

url = "https://{tenantDomain}/api/v2/log-streams"

payload = {
    "sink": {
        "httpEndpoint": "<string>",
        "httpAuthorization": "<string>",
        "httpContentType": "<string>",
        "httpCustomHeaders": [
            {
                "header": "<string>",
                "value": "<string>"
            }
        ]
    },
    "type": "http",
    "filters": [{ "type": "category" }],
    "isPriority": True,
    "name": "<string>",
    "startFrom": "2021-03-01T19:57:29.532Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/log-streams",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sink' => [
        'httpEndpoint' => '<string>',
        'httpAuthorization' => '<string>',
        'httpContentType' => '<string>',
        'httpCustomHeaders' => [
                [
                                'header' => '<string>',
                                'value' => '<string>'
                ]
        ]
    ],
    'type' => 'http',
    'filters' => [
        [
                'type' => 'category'
        ]
    ],
    'isPriority' => true,
    'name' => '<string>',
    'startFrom' => '2021-03-01T19:57:29.532Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/log-streams")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sink\": {\n    \"httpEndpoint\": \"<string>\",\n    \"httpAuthorization\": \"<string>\",\n    \"httpContentType\": \"<string>\",\n    \"httpCustomHeaders\": [\n      {\n        \"header\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"type\": \"http\",\n  \"filters\": [\n    {\n      \"type\": \"category\"\n    }\n  ],\n  \"isPriority\": true,\n  \"name\": \"<string>\",\n  \"startFrom\": \"2021-03-01T19:57:29.532Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/log-streams")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sink\": {\n    \"httpEndpoint\": \"<string>\",\n    \"httpAuthorization\": \"<string>\",\n    \"httpContentType\": \"<string>\",\n    \"httpCustomHeaders\": [\n      {\n        \"header\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  },\n  \"type\": \"http\",\n  \"filters\": [\n    {\n      \"type\": \"category\"\n    }\n  ],\n  \"isPriority\": true,\n  \"name\": \"<string>\",\n  \"startFrom\": \"2021-03-01T19:57:29.532Z\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "filters": [
    {
      "type": "category"
    }
  ],
  "id": "<string>",
  "isPriority": true,
  "name": "<string>",
  "pii_config": {
    "log_fields": [],
    "algorithm": "xxhash"
  },
  "sink": {
    "httpEndpoint": "<string>",
    "httpAuthorization": "<string>",
    "httpContentType": "<string>",
    "httpCustomHeaders": [
      {
        "header": "<string>",
        "value": "<string>"
      }
    ]
  },
  "type": "http"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

sink · object · requerido

Show child attributes

type · enum<string> · requerido

Opciones disponibles: http

filters · object[]

Solo el flujo entregará los eventos de log que coincidan con estos filtros. Si se omiten o están vacíos, se entregarán todos los eventos.

Show child attributes

isPriority · boolean

True para los flujos de registros prioritarios; false para los no prioritarios

name · string

nombre del flujo de registros

pii_config · object

Show child attributes

startFrom · string · predeterminado: 2021-03-01T19:57:29.532Z

La fecha y hora opcional (ISO 8601) a partir de la cual se iniciará la transmisión de logs

Respuesta

200

application/json

Flujo de registros creado

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

filters · object[]

Solo se entregarán mediante el flujo los eventos de registro que coincidan con estos filtros. Si se omite o está vacío, se entregarán todos los eventos.

Show child attributes

id · string<log-stream-id>

El id del flujo de registros

isPriority · boolean

Verdadero para los flujos de registros prioritarios; falso para los no prioritarios

name · string

nombre del flujo de registros

pii_config · object

Show child attributes

sink · object

Show child attributes

status · enum<string>

El estado del flujo de registros. Valores posibles: active, paused, suspended

Opciones disponibles: active, paused, suspended

type · enum<string>

Opciones disponibles: http