ログストリームを作成

ログストリームを作成します。

ログストリームの種類

作成するログストリームの type によって、sink ペイロードに必要なプロパティが決まります。

HTTP ストリーム

http ストリームの場合、sink のプロパティを以下のペイロードに示します。

リクエスト:

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

レスポンス:

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

Amazon EventBridge ストリーム

eventbridge ストリームの場合、sink のプロパティを以下のペイロードに示します。

リクエスト:

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

レスポンスの sink には、追加フィールド awsPartnerEventSource が含まれます。

レスポンス:

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

Azure Event Grid ストリーム

Azure Event Grid ストリームの場合、sink のプロパティを以下のペイロードに示します。

リクエスト:

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

レスポンス:

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

Datadog ストリーム

Datadog ストリームの場合、sink のプロパティを以下のペイロードに示します。

リクエスト:

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

レスポンス:

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

Splunk ストリーム

Splunk ストリームの場合、sink のプロパティを以下のペイロードに示します。

リクエスト:

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

レスポンス:

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

Sumo Logic ストリーム

Sumo Logic ストリームの場合、sink のプロパティを以下のペイロードに示します。

リクエスト:

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

レスポンス:

{
  "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"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

sink · object · 必須

Show child attributes

type · enum<string> · 必須

利用可能なオプション: http

filters · object[]

これらのフィルターに一致するログイベントのみがストリームによって配信されます。省略されているか空の場合は、すべてのイベントが配信されます。

Show child attributes

isPriority · boolean

優先ログストリームの場合は true、それ以外の場合は false

name · string

ログストリーム名

pii_config · object

Show child attributes

startFrom · string · デフォルト: 2021-03-01T19:57:29.532Z

ログのストリーミングを開始する任意の日時（ISO 8601）

レスポンス

200

application/json

ログストリームを作成しました

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

filters · object[]

これらのフィルターに一致するログイベントのみがストリームから配信されます。省略した場合、または空の場合は、すべてのイベントが配信されます。

Show child attributes

id · string<log-stream-id>

ログストリームの ID

isPriority · boolean

優先ログストリームの場合は true、非優先の場合は false

name · string

ログストリーム名

pii_config · object

Show child attributes

sink · object

Show child attributes

status · enum<string>

ログストリームの status。指定可能な値: active、paused、suspended

利用可能なオプション: active, paused, suspended

type · enum<string>

利用可能なオプション: http