aboutsummaryrefslogtreecommitdiffstats
path: root/memo-supervisor.txt
blob: f38c05d8792c8ec41afd61e160342a8422971808 (plain)
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
Run the supervisor on the target for the public IP:
---------------------------------------------------

	# afs-supervisor --port 1619 --token HELLO

Run the client
--------------

	# afb-client-demo -H host:1619/api?token=HELLO


verbs that can be run, all are of the API 'supervisor':
-------------------------------------------------------

	- discover

		send SIGHUP to daemons not recorded to make them connected

	- list

		list the connected daemons

	- config        {"pid":X}

		get the configuration of the daemon of pid X

	- sessions      {"pid":X}

		get the active sessions and token of the daemon of pid X

	- session-close {"pid":X, "uuid":UUID}

		closes the sessions of uuid UUID for the daemon of pid X

	- exit          {"pid":X,"code":Y}

		exit the daemon of pid X with optional code Y (default 0)

	- debug-wait    {"pid":X}

		make the daemon of pid X wait for a signal SIGINT

	- debug-break   {"pid":X}

		make the daemon of pid X self killing with SIGINT

	- do            {"pid":X,"api":A,"verb":V,"args":A}

		execute the API/VERB(ARGS) for the daemon of pid X

		useful for (s/g)etting monitor info. ex: monitor/get({"apis":true})

		bound to the current client session (to be checked: usurpation of session?)

	- trace         {"pid":X, ...}

		like monitor/trace but not bound to session (in the future monitor/trace
		will be bound to sessions)

		allows to trace specific session or any session

		the pid isn't returned in the event (not sure to want it but open...)

		use "name" and "tag" feature of "trace" to discriminate events on the client side.

Examples of dialog:
-------------------

supervisor discover
ON-REPLY 1:supervisor/discover: OK
{
  "jtype":"afb-reply",
  "request":{
    "status":"success",
    "uuid":"22563ce6-e07f-4284-91f8-e7eb7ec4ef21"
  }
}


supervisor list
ON-REPLY 2:supervisor/list: OK
{
  "response":{
    "7054":{
      "pid":7054,
      "uid":1001,
      "gid":1001,
      "id":"NoLabel",
      "label":"NoLabel",
      "user":"1001"
    }
  },
  "jtype":"afb-reply",
  "request":{
    "status":"success"
  }
}



supervisor config {"pid":7054}
ON-REPLY 3:supervisor/config: OK
{
  "response":{
    "console":".\/AFB-console.out",
    "rootdir":".",
    "roothttp":"..\/test",
    "rootbase":"\/opa",
    "rootapi":"\/api",
    "workdir":".",
    "uploaddir":".",
    "token":"",
    "name":null,
    "aliases":[
      "\/monitoring"
    ],
    "dbus_clients":[
    ],
    "dbus_servers":[
    ],
    "ws_clients":[
    ],
    "ws_servers":[
    ],
    "so_bindings":[
    ],
    "ldpaths":[
      "\/opt\/jobol\/lib64\/afb"
    ],
    "weak_ldpaths":[
    ],
    "calls":[
    ],
    "exec":[
    ],
    "httpdPort":5555,
    "cacheTimeout":100000,
    "apiTimeout":20,
    "cntxTimeout":32000000,
    "nbSessionMax":10,
    "mode":"local",
    "tracereq":"no",
    "traceditf":"no",
    "tracesvc":"no",
    "traceevt":"no",
    "traceses":"no",
    "no_ldpaths":false,
    "noHttpd":false,
    "background":false,
    "monitoring":true,
    "random_token":false
  },
  "jtype":"afb-reply",
  "request":{
    "status":"success"
  }
}





supervisor sessions {"pid":7054}
ON-REPLY 4:supervisor/sessions: OK
{
  "response":{
    "2273ff8d-ee46-4059-959b-0f90fa90f25e":{
      "token":""
    },
    "22563ce6-e07f-4284-91f8-e7eb7ec4ef21":{
      "token":""
    }
  },
  "jtype":"afb-reply",
  "request":{
    "status":"success"
  }
}





supervisor do {"pid":7054,"api":"monitor","verb":"get","args":{"apis":true}}
.....VERY LONG RESPONSE.....




supervisor trace { "pid": 7054, "add": { "request": "common" } }
ON-REPLY 6:supervisor/trace: OK
{
  "jtype":"afb-reply",
  "request":{
    "status":"success"
  }
}





ON-EVENT supervisor/trace:
{
  "event":"supervisor\/trace",
  "data":{
    "time":"34353.598120",
    "tag":"trace",
    "type":"request",
    "id":34,
    "request":{
      "index":1,
      "api":"ave",
      "verb":"ping",
      "action":"begin",
      "session":"be67cfb8-a346-47c1-ac63-65aaff3599bf"
    }
  },
  "jtype":"afb-event"
}
ON-EVENT supervisor/trace:
{
  "event":"supervisor\/trace",
  "data":{
    "time":"34353.598182",
    "tag":"trace",
    "type":"request",
    "id":35,
    "request":{
      "index":1,
      "api":"ave",
      "verb":"ping",
      "action":"json",
      "session":"be67cfb8-a346-47c1-ac63-65aaff3599bf"
    },
    "data":{
      "result":"true"
    }
  },
  "jtype":"afb-event"
}
ON-EVENT supervisor/trace:
{
  "event":"supervisor\/trace",
  "data":{
    "time":"34353.598214",
    "tag":"trace",
    "type":"request",
    "id":36,
    "request":{
      "index":1,
      "api":"ave",
      "verb":"ping",
      "action":"success",
      "session":"be67cfb8-a346-47c1-ac63-65aaff3599bf"
    },
    "data":{
      "result":"Some String",
      "info":"Ping Binder Daemon tag=pingSample count=1 query=\"true\""
    }
  },
  "jtype":"afb-event"
}
ON-EVENT supervisor/trace:
{
  "event":"supervisor\/trace",
  "data":{
    "time":"34353.598292",
    "tag":"trace",
    "type":"request",
    "id":37,
    "request":{
      "index":1,
      "api":"ave",
      "verb":"ping",
      "action":"end",
      "session":"be67cfb8-a346-47c1-ac63-65aaff3599bf"
    }
  },
  "jtype":"afb-event"
}


Usefull commands:
-----------------

  TARGET=...

  afb-client-demo -H ws://$TARGET:1619/api?token=HELLO\&uuid=HELLO supervisor list

  afb-client-demo -H ws://$TARGET:1619/api?token=HELLO\&uuid=HELLO config '{"pid":XXXX}'