File: channels_statistics.textile

package info (click to toggle)
libnginx-mod-http-push-stream 0.6.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,272 kB
  • sloc: ruby: 7,101; ansic: 6,048; javascript: 2,121; sh: 53; makefile: 16
file content (32 lines) | stat: -rw-r--r-- 1,791 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
h1(#channels_statistic). Channel Statistics Configuration

h2(#push_stream_channels_statistics). push_stream_channels_statistics <a name="push_stream_channels_statistics" href="#">&nbsp;</a>

*syntax:* _push_stream_channels_statistics_

*context:* _location_

*release version:* _0.2.0_

Defines a location as a source of statistics. You can use this location to get statistics about a specific, group or all channels, in a resumed or summarized way.
To get statistics about:
- all channels in a summarized way, you have to make a GET in this location without specify a name in the push_stream_channels_path directive.
- all channels in a detailed way, you have to specify "ALL" in the push_stream_channels_path.
- prefixed channels in a detailed way, you have to specify "_prefix_ *" in the push_stream_channels_path.
- a channel, you have to specify the name in the push_stream_channels_path.
- some channels, you have to specify their names in the push_stream_channels_path.

You can get statistics in the formats plain, xml, yaml and json. The default is json, to change this behavior you can use *Accept* header parameter passing values like "text/plain", "application/xml", "application/yaml" and "application/json" respectively.

<pre>
  location /channels-stats {
      push_stream_channels_statistics;
      push_stream_channels_path               $arg_id;
  }

  # /channels-stats -> get statistics about all channels in a summarized way
  # /channels-stats?id=ALL -> get statistics about all channels in a detailed way
  # /channels-stats?id=channel_* -> get statistics about all channels which starts with 'channel_'
  # /channels-stats?id=channel_id -> get statistics about a channel
  # /channels-stats?id=channel_id_1/channel_id_5 -> get statistics about some channels
</pre>