Observability

List Observability log patterns

List log patterns (clustered log templates) with counts against the previous window of the same length. Only service:, severity: and pattern: filters apply; others are echoed in meta.ignored_filters. Each pattern’s logs_query drills into matching rows with GET /v1/observability/logs. Requires a personal or Global API key (Team API Keys are group-scoped and get 403 unsupported_api_key) or an OAuth token with the all scope, and the Observability logs read permission. Limited to 60 requests per minute per token.

GET

observability

patterns

curl --request GET \
  --url https://api.rootly.com/v1/observability/patterns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/observability/patterns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/observability/patterns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/observability/patterns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/observability/patterns")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "type": "observability_log_patterns",
      "attributes": {
        "service": "<string>",
        "pattern_hash": "<string>",
        "template": "<string>",
        "total": 123,
        "previous_total": 123,
        "change_percent": 123,
        "errors": 123,
        "warnings": 123,
        "max_severity": "<string>",
        "first_seen": "2023-11-07T05:31:56Z",
        "detectors": [
          "<string>"
        ],
        "logs_query": "<string>"
      }
    }
  ],
  "meta": {
    "query": "<string>",
    "window": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "previous_window": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "sort": "<string>",
    "flagged": true,
    "returned": 123,
    "truncated": true,
    "warnings": [
      {
        "code": "no_data",
        "detail": "<string>"
      }
    ],
    "ignored_filters": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

filter[query]

string

Query using service:, severity: and pattern: filters, e.g. service:checkout severity:error.

filter[from]

string

Window start: ISO8601 or relative like now-6h. Defaults to now-1h. At most 7 days long, within the last 30 days.

filter[to]

string

Window end: ISO8601 or relative like now. Defaults to now.

filter[flagged]

boolean

Only patterns flagged by a detector (new, spike, error surge).

sort

enum<string>

default:count

count for the most frequent patterns, change for the biggest change against the previous window.

Available options:

count,

change

page[size]

integer

default:15

Patterns to return.

Required range: 1 <= x <= 25

Response

Patterns with the effective query and windows

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

⌘I

List Observability log patterns

curl --request GET \
  --url https://api.rootly.com/v1/observability/patterns \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/observability/patterns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/observability/patterns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootly.com/v1/observability/patterns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/observability/patterns")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "<string>",
      "type": "observability_log_patterns",
      "attributes": {
        "service": "<string>",
        "pattern_hash": "<string>",
        "template": "<string>",
        "total": 123,
        "previous_total": 123,
        "change_percent": 123,
        "errors": 123,
        "warnings": 123,
        "max_severity": "<string>",
        "first_seen": "2023-11-07T05:31:56Z",
        "detectors": [
          "<string>"
        ],
        "logs_query": "<string>"
      }
    }
  ],
  "meta": {
    "query": "<string>",
    "window": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "previous_window": {
      "from": "2023-11-07T05:31:56Z",
      "to": "2023-11-07T05:31:56Z"
    },
    "sort": "<string>",
    "flagged": true,
    "returned": 123,
    "truncated": true,
    "warnings": [
      {
        "code": "no_data",
        "detail": "<string>"
      }
    ],
    "ignored_filters": "<string>"
  }
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "<string>",
      "code": "<string>",
      "title": "<string>",
      "source": {
        "parameter": "<string>"
      }
    }
  ]
}