Merge "Added validation on matching required fields"
[policy/engine.git] / docs / platform / feature_eelf.rst
1
2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4
5 *************************************************
6 Feature: EELF (Event and Error Logging Framework) 
7 *************************************************
8
9 .. contents::
10     :depth: 3
11
12 Summary
13 ^^^^^^^
14 The EELF feature provides backwards compatibility with R0 logging functionality. It supports the use of EELF/Common Framework style logging at the same time as traditional logging.
15
16 .. seealso:: Additional information for EELF logging can be found at `EELF wiki`_.
17
18 .. _EELF wiki: https://github.com/att/EELF/wiki
19
20
21 Usage
22 ^^^^^
23
24 To utilize the eelf logging capabilities, first stop policy engine and then enable the feature using the "*features*" command.
25
26     .. code-block:: bash
27        :caption: Enabling EELF Feature
28
29         policy@hyperion-4:/opt/app/policy$ policy stop
30         [drools-pdp-controllers]
31          L []: Stopping Policy Management... Policy Management (pid=354) is stopping... Policy Management has stopped.
32         policy@hyperion-4:/opt/app/policy$ features enable eelf
33         name                      version         status
34         ----                      -------         ------
35         controlloop-utils         1.1.0-SNAPSHOT  disabled
36         healthcheck               1.1.0-SNAPSHOT  disabled
37         test-transaction          1.1.0-SNAPSHOT  disabled
38         eelf                      1.1.0-SNAPSHOT  enabled
39         state-management          1.1.0-SNAPSHOT  disabled
40         active-standby-management 1.1.0-SNAPSHOT  disabled
41         session-persistence       1.1.0-SNAPSHOT  disabled
42
43 The output of the enable command will indicate whether or not the feature was enabled successfully.
44
45 Policy engine can then be started as usual.
46
47
48
49 End of Document
50
51 .. SSNote: Wiki page ref. https://wiki.onap.org/display/DW/Feature+EELF
52