Skip to content

Management socket

major edited this page Aug 20, 2019 · 8 revisions

A UNIX socket is available for runtime administration /var/run/darwin/socket/darwin.sock. For now, it allows the following commands:

Monitoring

Can be used at any time to get monitoring information from all the currently working filters.

Request:

{
  "type": "monitor"
}

Response example (this one is deprecated since 0.2, need to implement new monitoring):

{
  "example_1337": {
    "available_threads": 5, 
    "working_threads": 3
  }, 
  "example_7070": {
    "available_threads": 2,
    "working_threads": 0
  }
}

Filters Update

SHOULD be used to reload configuration of some filters; to do so, please rewrite the configuration file first.

Request:

{
  "type": "update_filters",
  "filters": [
    "example_1337",
    "example_7070"
  ]
}

Response (only sent when update is finished, it may take a few moments):

Success:

{
  "status": "OK"
}

Failure:

{
  "status": "KO",
  "errors": [
    {
      "filter": "example_1337",
      "error": "Filter not existing"
    }
  ]
}
Clone this wiki locally