Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

REST methods and response statuses

REST method

Example of REST request

Example of REST response

Response status

Description

/logger/enable_client_log

Code Block
languagejs
themeRDark
{
 "sessionId": "/127.0.0.1:57539/192.168.1.101:8443",
 "logLevel": "DEBUG"
}

200 - Logging level is changed

404 - Session not found


Set the logging level specified in session specified

/logger/disable_client_log

Code Block
languagejs
themeRDark
{
 "sessionId": "/127.0.0.1:57539/192.168.1.101:8443"
}

200 - Logging is disabled

404 - Session not found

Fully disable logging in session specified

Parameters

Parameter name

Description

Example

sessionId

Session Id

/127.0.0.1:57539/192.168.1.101:8443

logLevel

Logging level to set

DEBUG

Thus, when problem occurs with stream published on server (for example, the stream is published but cannot be played), REST query should be sent to server to switch logging level to DEBUG and then, when problem is reproduced and data are collected, to switch logging level back to INFO. Also it is possible to switch logging off in certain client session.

Logging level changes with REST queries affects only the session specified, but not another sessions including sessions that will be created later.

Using flight recorder

Flight recorder function allows to cyclically write some latest events for stream published. This information may help to diagnose problems with stream publishing without full client debug logs enabling. Flight recorder is enabled with the following parameter in flashphoner.properties file

Code Block
languagebash
themeRDark
enable_flight_recorder=true

It is necessary to set events category that will be written (defined by developer)

Code Block
languagebash
themeRDark
flight_recorder_categories=WCS1438

The events are written for publisher client to flight_recorder.log file. To save the events for all publishers connected, the parameter should be set

Code Block
languagebash
themeRDark
enable_flight_recorder_test=true

without restarting WCS server.

Client log structure and content

...

Traffic is recorded using tcpdump, if this utility is installed in the system.

flight_recorder.log log

Last events for stream published are written to this file.

Server logs

WCS Core records general server logs to logs/server_logs

...