Log Stream Widget

The Log Stream displays a log flow matching the defined query.

Setup

Log stream configuration filtered by source:nodejs with three columns for date, host, and service

Configuration

  1. Enter a search query to filter the log stream.
  2. You can group logs into event subsets of Log Analytics, which include Patterns and Transactions.
  3. Update the columns to display the values of your facets and measures.
  4. Give your graph a title or leave the box blank for the suggested title.

API

This widget can be used with the Dashboards API. See the following table for the widget JSON schema definition:

Expand All

Field

Type

Description

columns

[string]

Which columns to display on the widget.

indexes

[string]

An array of index names to query in the stream. Use [] to query all indexes at once.

logset

string

DEPRECATED: ID of the log set to use.

message_display

enum

Amount of log lines to display Allowed enum values: inline,expanded-md,expanded-lg

query

string

Query to filter the log stream with.

show_date_column

boolean

Whether to show the date column or not

show_message_column

boolean

Whether to show the message column or not

sort

object

Which column and order to sort by

column [required]

string

Facet path for the column

order [required]

enum

Widget sorting methods. Allowed enum values: asc,desc

time

object

Time setting for the widget.

live_span

enum

The available timeframes depend on the widget you are using. Allowed enum values: 1m,5m,10m,15m,30m,1h,4h,1d,2d,1w,1mo,3mo,6mo,1y,alert

title

string

Title of the widget.

title_align

enum

How to align the text on the widget. Allowed enum values: center,left,right

title_size

string

Size of the title.

type [required]

enum

Type of the log stream widget. Allowed enum values: log_stream

default: log_stream

{
  "columns": [],
  "indexes": [
    "days-3",
    "days-7"
  ],
  "logset": "string",
  "message_display": "string",
  "query": "string",
  "show_date_column": false,
  "show_message_column": false,
  "sort": {
    "column": "",
    "order": "desc"
  },
  "time": {
    "live_span": "5m"
  },
  "title": "string",
  "title_align": "string",
  "title_size": "string",
  "type": "log_stream"
}

Further Reading

Additional helpful documentation, links, and articles:

Log AnalyticsDOCUMENTATION more more Building Dashboards using JSONDOCUMENTATION more more