support-logging API documentation version 1.1.x

http://localhost:48061/api

Welcome

Welcome to the EdgeX Foundry Logging Microservice API Documentation.

/v1/logs

post

post

Create a new LogEntry

Create a new LogEntry

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "LogEntry Schema",
  "type": "object",
  "properties": {
    "originService": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "logLevel": {
      "enum": ["TRACE","DEBUG","INFO","WARN","ERROR"]
    },
    "created": {
      "description": "The creation timestamp",
      "type": "integer",
      "minimum": 0
    }
  },
  "required": ["originService","message","logLevel"]
}

Example:

{
  "logLevel": "WARN",
  "originService": "service1",
  "message": "Hello, Logging Service!"
}

HTTP status code 202

accepted to clients with timestamp being accepted.

HTTP status code 400

creation request is malformed

get

get

URI Parameters

  • limit: required (number)

    the maximum number of records to fetch

    Example:

    10

HTTP status code 200

list a collection of LogEntry - limited in size by the limit parameter

Body

Type: application/json

Schema:

array

Example:

[
  {
    "logLevel": "WARN",
    "originService": "service1",
    "message": "Hello, Logging Service!",
    "created": 1469175494527
  },
  {
    "logLevel": "INFO",
    "originService": "service2",
    "message": "Hello, Logging Service!",
    "created": 1469175494528
  }
]

HTTP status code 413

if the number of events exceeds the current max limit

HTTP status code 500

for unknown or unanticipated issues.

get

get

URI Parameters

  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899
  • limit: required (number)

    the maximimum number of records to fetch

    Example:

    10

HTTP status code 200

list a collection of LogEntry created between the specified start and end dates - limited in size by the limit parameter

Body

Type: application/json

Schema:

array

Example:

[
  {
    "logLevel": "WARN",
    "originService": "service1",
    "message": "Hello, Logging Service!",
    "created": 1469175494527
  },
  {
    "logLevel": "INFO",
    "originService": "service2",
    "message": "Hello, Logging Service!",
    "created": 1469175494528
  }
]

HTTP status code 413

if the number of events exceeds the current max limit

HTTP status code 500

for unknown or unanticipated issues.

get

get

URI Parameters

  • originServices: required (string)

    accepting multiple originServices separated by comma

    Example:

    service1,service2,service3
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899
  • limit: required (number)

    the maximum number of records to fetch

    Example:

    10

HTTP status code 200

list a collection of LogEntry matching any of the specified originServices and being created between the specified start and end dates - limited in size by the limit parameter

Body

Type: application/json

Schema:

array

Example:

[
  {
    "logLevel": "WARN",
    "originService": "service1",
    "message": "Hello, Logging Service!",
    "created": 1469175494527
  },
  {
    "logLevel": "INFO",
    "originService": "service2",
    "message": "Hello, Logging Service!",
    "created": 1469175494528
  }
]

HTTP status code 413

if the number of events exceeds the current max limit

HTTP status code 500

for unknown or unanticipated issues.

get

get

URI Parameters

  • keywords: required (string)

    accepting multiple keywords separated by comma

    Example:

    keyword1,keyword2,keyword3
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899
  • limit: required (number)

    the maximum number of records to fetch

    Example:

    10

HTTP status code 200

list a collection of LogEntry whose message containing any of the specified keywords and being created between the specified start and end dates - limited in size by the limit parameter

Body

Type: application/json

Schema:

array

Example:

[
  {
    "logLevel": "WARN",
    "originService": "service1",
    "message": "Hello, Logging Service!",
    "created": 1469175494527
  },
  {
    "logLevel": "INFO",
    "originService": "service2",
    "message": "Hello, Logging Service!",
    "created": 1469175494528
  }
]

HTTP status code 413

if the number of events exceeds the current max limit

HTTP status code 500

for unknown or unanticipated issues.

get

get

URI Parameters

  • logLevels: required (string)

    accepting multiple logLevels separated by comma

    Example:

    ERROR,WARN,INFO,DEBUG,TRACE
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899
  • limit: required (number)

    the maximum number of records to fetch

    Example:

    10

HTTP status code 200

list a collection of LogEntry matching any of the specified logLevels and being created between the specified start and end dates - limited in size by the limit parameter

Body

Type: application/json

Schema:

array

Example:

[
  {
    "logLevel": "WARN",
    "originService": "service1",
    "message": "Hello, Logging Service!",
    "created": 1469175494527
  },
  {
    "logLevel": "INFO",
    "originService": "service2",
    "message": "Hello, Logging Service!",
    "created": 1469175494528
  }
]

HTTP status code 413

if the number of events exceeds the current max limit

HTTP status code 500

for unknown or unanticipated issues.

get

get

URI Parameters

  • logLevels: required (string)

    accepting multiple logLevels separated by comma

    Example:

    ERROR,WARN,INFO,DEBUG,TRACE
  • originServices: required (string)

    accepting multiple originServices separated by comma

    Example:

    service1,service2,service3
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899
  • limit: required (number)

    the maximum number of records to fetch

    Example:

    10

HTTP status code 200

list a collection of LogEntry matching any of the specified logLevels, originServices, and also being created between the specified start and end dates - limited in size by the limit parameter

Body

Type: application/json

Schema:

array

Example:

[
  {
    "logLevel": "WARN",
    "originService": "service1",
    "message": "Hello, Logging Service!",
    "created": 1469175494527
  },
  {
    "logLevel": "INFO",
    "originService": "service2",
    "message": "Hello, Logging Service!",
    "created": 1469175494528
  }
]

HTTP status code 413

if the number of events exceeds the current max limit

HTTP status code 500

for unknown or unanticipated issues.

delete

delete

URI Parameters

  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899

HTTP status code 200

count of the number of LogEntry being deleted

HTTP status code 503

for unknown or unanticipated issues.

delete

delete

URI Parameters

  • originServices: required (string)

    accepting multiple originServices separated by comma

    Example:

    service1,service2,service3
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899

HTTP status code 200

count of the number of LogEntry being deleted

HTTP status code 500

for unknown or unanticipated issues.

delete

delete

URI Parameters

  • keywords: required (string)

    accepting multiple keywords separated by comma

    Example:

    keyword1,keyword2,keyword3
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899

HTTP status code 200

count of the number of LogEntry being deleted

HTTP status code 500

for unknown or unanticipated issues.

delete

delete

URI Parameters

  • logLevels: required (string)

    accepting multiple logLevels separated by comma

    Example:

    ERROR,WARN,INFO,DEBUG,TRACE
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899

HTTP status code 200

count of the number of LogEntry being deleted

HTTP status code 500

for unknown or unanticipated issues.

delete

delete

URI Parameters

  • logLevels: required (string)

    accepting multiple logLevels separated by comma

    Example:

    ERROR,WARN,INFO,DEBUG,TRACE
  • originServices: required (string)

    accepting multiple originServices separated by comma

    Example:

    service1,service2,service3
  • start: required (number)

    start date in long form

    Example:

    1469175494521
  • end: required (number)

    end date in long form

    Example:

    1469175499899

HTTP status code 200

count of the number of LogEntry being deleted

HTTP status code 500

for unknown or unanticipated issues.

delete

delete

URI Parameters

  • age: required (number)

    minimum age in milliseconds (from created timestamp) a LogEntry should be in order to be removed

    Example:

    604800000

HTTP status code 200

count of the number of LogEntry being deleted

HTTP status code 500

for unknown or unanticipated issues.

Ping Resource

example - http://localhost:48061/api/v1/ping

get

get

Test service providing an indication that the service is available.

Config Resource

Example - http://localhost:48061/api/v1/config

get

get

Fetch the current state of the service's configuration.

Edgex API Version

Example - http://localhost:48061/api/version

get

get

Get the API version