Add license to docs files
[platform-oam.git] / docs / Developer_Guide.rst
1 .. ===============LICENSE_START=======================================================
2 .. Acumos
3 .. ===================================================================================
4 .. Copyright (C) 2017-2018 AT&T Intellectual Property & Tech Mahindra. All rights reserved.
5 .. ===================================================================================
6 .. This Acumos documentation file is distributed by AT&T and Tech Mahindra
7 .. under the Creative Commons Attribution 4.0 International License (the "License");
8 .. you may not use this file except in compliance with the License.
9 .. You may obtain a copy of the License at
10 ..  
11 ..      http://creativecommons.org/licenses/by/4.0
12 ..  
13 .. This file is distributed on an "AS IS" BASIS,
14 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 .. See the License for the specific language governing permissions and
16 .. limitations under the License.
17 .. ===============LICENSE_END=========================================================
18 =================
19 Developer's Guide
20 =================
21
22 Acumos ELK stack for log analytics
23 ===================================
24 This guide that describes how to use the Acumos ELK Stack.
25
26 1. Introduction
27 ---------------
28 One of the functions of Operations, Administration, and Management (OA&M) for the Acumos platform is to collect and correlate log files from the other platform components in order to support debugging, metrics, alarms, etc. for development and operations purposes. To this end, the OA&M component has defined a logging standard to be used by all of those components in order to support correlation. 
29
30         1.1 What is Acumos ELK Stack?
31                 OAM are the processes, activities, tools, and standards involved with operating, administering, managing and maintaining any system. Collecting Logs of all the micro-services involved can reveal about the system that can mitigate potential risks. There are many ways we can collect logs that are generated via the micro-services. One of them is ELK stack. 
32                 ELK stands for, E- Elasticsearch L- Logstash K-Kibana           
33         Note: Filebeats( a lightweight log shipping tools is also used to ship the logs to the servers)
34
35         1.2 Target Users
36                 This guide is targeted towards the open source user community that who have access of super site admin.
37   
38         1.3 Assumptions
39                 All the module should follow Acumos Log Standards.
40
41         1.4 ELK-Stack - Backend Architecture
42                 .. image:: images/elk_stack.png
43
44
45 2. ELK-Stack User Interface A Tour
46 ----------------------------------
47 Site admin having access to ELK stack Login to dashboard:
48
49 .. image:: images/acumosSiteAdminUntitled.png
50
51 Kibana is an open source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis and visualize your data in a variety of charts, tables, and maps.
52 Kibana makes it easy to understand large volumes of data. Its simple, browser-based interface enables you to quickly create queries in real time.
53
54 For more details visit `Kibana User Guide <https://www.elastic.co/guide/en/kibana/current/index.html/>`_.
55
56
57 .. image:: images/loadingKibanaCapture.PNG