ログストリームを作成

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

ログストリームの種類

作成するログストリームの 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,
    )
}

200

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

承認

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