Class LogStreams

Retrieve details on log streams.

Sample Response

[{
	"id": "string",
	"name": "string",
	"type": "eventbridge",
	"status": "active|paused|suspended",
	"sink": {
		"awsAccountId": "string",
		"awsRegion": "string",
		"awsPartnerEventSource": "string"
	}
}, {
	"id": "string",
	"name": "string",
	"type": "http",
	"status": "active|paused|suspended",
	"sink": {
		"httpContentFormat": "JSONLINES|JSONARRAY",
		"httpContentType": "string",
		"httpEndpoint": "string",
		"httpAuthorization": "string"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "eventgrid",
	"status": "active|paused|suspended",
	"sink": {
		"azureSubscriptionId": "string",
		"azureResourceGroup": "string",
		"azureRegion": "string",
		"azurePartnerTopic": "string"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "splunk",
	"status": "active|paused|suspended",
	"sink": {
		"splunkDomain": "string",
		"splunkToken": "string",
		"splunkPort": "string",
		"splunkSecure": "boolean"
	}
},
{
	"id": "string",
	"name": "string",
	"type": "sumo",
	"status": "active|paused|suspended",
	"sink": {
		"sumoSourceAddress": "string",
	}
},
{
	"id": "string",
	"name": "string",
	"type": "datadog",
	"status": "active|paused|suspended",
	"sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
	}
}]

await client.logStreams.list()
Copy

Create a log stream.

Log Stream Types

The type of log stream being created determines the properties required in the sink payload.

HTTP Stream

For an http Stream, the sink properties are listed in the payload below Request:

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

Response:

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

Amazon EventBridge Stream

For an eventbridge Stream, the sink properties are listed in the payload below Request:

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

The response will include an additional field awsPartnerEventSource in the sink:

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

Azure Event Grid Stream

For an Azure Event Grid Stream, the sink properties are listed in the payload below Request:

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

Response:

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

Datadog Stream

For a Datadog Stream, the sink properties are listed in the payload below Request:

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

Response:

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

Splunk Stream

For a Splunk Stream, the sink properties are listed in the payload below Request:

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

Response:

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

Sumo Logic Stream

For a Sumo Logic Stream, the sink properties are listed in the payload below Request:

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

Response:

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

await client.logStreams.create({
        type: "http",
        sink: {
            httpEndpoint: "httpEndpoint"
        }
    })
Copy

Retrieve a log stream configuration and status.

Sample responses

Amazon EventBridge Log Stream

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

HTTP Log Stream

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

Datadog Log Stream

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

Mixpanel

Request: <pre><code>{
  "name": "string",
  "type": "mixpanel",
  "sink": {
	"mixpanelRegion": "string", // "us" | "eu",
	"mixpanelProjectId": "string",
	"mixpanelServiceAccountUsername": "string",
	"mixpanelServiceAccountPassword": "string"
  }
} </code></pre>


Response: <pre><code>{
	"id": "string",
	"name": "string",
	"type": "mixpanel",
	"status": "active",
	"sink": {
	  "mixpanelRegion": "string", // "us" | "eu",
	  "mixpanelProjectId": "string",
	  "mixpanelServiceAccountUsername": "string",
	  "mixpanelServiceAccountPassword": "string" // the following is redacted on return
	}
  } </code></pre>

<h5>Segment</h5>

Request: <pre><code> {
  "name": "string",
  "type": "segment",
  "sink": {
	"segmentWriteKey": "string"
  }
}</code></pre>

Response: <pre><code>{
  "id": "string",
  "name": "string",
  "type": "segment",
  "status": "active",
  "sink": {
	"segmentWriteKey": "string"
  }
} </code></pre>

Splunk Log Stream

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

Sumo Logic Log Stream

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

Status

The status of a log stream maybe any of the following: 1. active - Stream is currently enabled. 2. paused - Stream is currently user disabled and will not attempt log delivery. 3. suspended - Stream is currently disabled because of errors and will not attempt log delivery.

await client.logStreams.get("id")
Copy

Delete a log stream.

await client.logStreams.delete("id")
Copy

Update a log stream.

Examples of how to use the PATCH endpoint.

The following fields may be updated in a PATCH operation:

• name
• status
• sink

Note: For log streams of type eventbridge and eventgrid, updating the sink is not permitted.

Update the status of a log stream

{
	"status": "active|paused"
}

Update the name of a log stream

{
	"name": "string"
}

Update the sink properties of a stream of type http

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

Update the sink properties of a stream of type datadog

{
  "sink": {
		"datadogRegion": "string",
		"datadogApiKey": "string"
  }
}

Update the sink properties of a stream of type splunk

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

Update the sink properties of a stream of type sumo

{
  "sink": {
    "sumoSourceAddress": "string"
  }
}

await client.logStreams.update("id")
Copy