|
1 | 1 | # scouter-pulse |
2 | 2 | Pulse is the platform for building lightweight agent program for many types of data you want to enrich with Scouter. Whether you’re interested in system performance metrics. |
3 | 3 |
|
4 | | -```json |
5 | | -{ |
6 | | - "object" : { |
7 | | - "type" : "type_name", |
8 | | - "display" : "DisplayName" |
9 | | - }, |
10 | | - "counters" : [ |
11 | | - {"name" : "counter1", |
12 | | - "unit" : "cnt", |
13 | | - "display" : "Counter1", |
14 | | - }, |
15 | | - {"name" : "counter2", |
16 | | - "unit" : "cnt", |
17 | | - "display" : "Counter2", |
18 | | - }, |
19 | | - {"name" : "counter3", |
20 | | - "unit" : "cnt", |
21 | | - "display" : "Counter3", |
22 | | - "total" : false |
23 | | - }, |
24 | | - ] |
25 | | -} |
26 | | -``` |
| 4 | +### Quick Start |
| 5 | +1. Start up scouter server with http enabled option |
| 6 | + > net_http_server_enabled=true |
27 | 7 |
|
28 | | - |
29 | | -```json |
30 | | -[ |
31 | | - { |
32 | | - "object" : { |
33 | | - "host" : "host1", |
34 | | - "name" : "name1", |
35 | | - "type" : "type_name", |
36 | | - "address" : "10.10.10.10" |
37 | | - }, |
38 | | - "counters" : [ |
39 | | - {"name" : "counter1", "value" : 55}, |
40 | | - {"name" : "counter2", "value" : 245}, |
41 | | - {"name" : "counter3", "value" : 4245} |
42 | | - ] |
43 | | - }, |
44 | | - { |
45 | | - "object" : { |
46 | | - "host" : "host2", |
47 | | - "name" : "name2", |
48 | | - "type" : "type_name", |
49 | | - "address" : "10.10.10.11" |
50 | | - }, |
| 8 | +2. Register object type and counter definition list by json once. It should be returned 201. |
| 9 | + > http://server_ip:6180/register |
| 10 | + ```json |
| 11 | + { |
| 12 | + "object" : { |
| 13 | + "type" : "type_name", |
| 14 | + "display" : "DisplayName" |
| 15 | + }, |
51 | 16 | "counters" : [ |
52 | | - {"name" : "counter1", "value" : 35}, |
53 | | - {"name" : "counter2", "value" : 65}, |
54 | | - {"name" : "counter3", "value" : 8888} |
| 17 | + {"name" : "counter1", |
| 18 | + "unit" : "cnt", |
| 19 | + "display" : "Counter1", |
| 20 | + }, |
| 21 | + {"name" : "counter2", |
| 22 | + "unit" : "cnt", |
| 23 | + "display" : "Counter2", |
| 24 | + }, |
| 25 | + {"name" : "counter3", |
| 26 | + "unit" : "cnt", |
| 27 | + "display" : "Counter3", |
| 28 | + "total" : false |
| 29 | + }, |
55 | 30 | ] |
56 | | - } |
57 | | - ] |
58 | | - ``` |
| 31 | + } |
| 32 | + ``` |
| 33 | + |
| 34 | +3. Send object heartbeat and counter value by json periodically(recommended 2~5sec). |
| 35 | + > http://server_ip:6180/counters |
| 36 | + ```json |
| 37 | + [ |
| 38 | + { |
| 39 | + "object" : { |
| 40 | + "host" : "host1", |
| 41 | + "name" : "name1", |
| 42 | + "type" : "type_name", |
| 43 | + "address" : "10.10.10.10" |
| 44 | + }, |
| 45 | + "counters" : [ |
| 46 | + {"name" : "counter1", "value" : 55}, |
| 47 | + {"name" : "counter2", "value" : 245}, |
| 48 | + {"name" : "counter3", "value" : 4245} |
| 49 | + ] |
| 50 | + }, |
| 51 | + { |
| 52 | + "object" : { |
| 53 | + "host" : "host2", |
| 54 | + "name" : "name2", |
| 55 | + "type" : "type_name", |
| 56 | + "address" : "10.10.10.11" |
| 57 | + }, |
| 58 | + "counters" : [ |
| 59 | + {"name" : "counter1", "value" : 35}, |
| 60 | + {"name" : "counter2", "value" : 65}, |
| 61 | + {"name" : "counter3", "value" : 8888} |
| 62 | + ] |
| 63 | + } |
| 64 | + ] |
| 65 | + ``` |
| 66 | + |
| 67 | + |
| 68 | + |
| 69 | + |
0 commit comments