Merge branch 'feature/example' into develop

andypan-twn · Sep 27, 2019 · 54aae90 · 54aae90
2 parents 7b64a80 + 5156a78
commit 54aae90
Show file tree

Hide file tree

Showing 14 changed files with 86 additions and 76 deletions.
diff --git a/.env.example b/.env.example
@@ -43,3 +43,20 @@ PUSHER_APP_CLUSTER=mt1
 
 MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
 MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+
+# E.L.K. setting
+ELK_VERSION=6.4.0
+
+# Elasticsearch
+ES_HOST=example-elasticsearch
+ES_PORT1=9200
+ES_PORT2=9300
+
+# Logstash
+LS_HOST=example-logstash
+LS_PORT1=5000
+LS_PORT2=9600
+
+# Kibana
+KB_HOST=example-kibana
+KB_PORT=5601
diff --git a/ELK/logstash/pipeline/logstash.conf b/ELK/logstash/pipeline/logstash.conf
@@ -5,7 +5,7 @@ input {
 
     file {
         type => "inputFile"
-        path => "/home/inputFile/log-*"
+        path => "/home/inputFile/*.log"
         start_position => "beginning"
     }
 }

diff --git a/README.md b/README.md
@@ -3,9 +3,54 @@ E.L.K. example for PHP laravel via docker.
 
 ## 如何使用
 
+1. 安裝 Docker
 
+    [官方安裝文件](https://docs.docker.com/install/)
 
-## 指令說明
+2. 產生 環境變數
+    ```bash
+        $ cp .env.example .env
+    ```
 
+3. 啟動
+    ```bash
+        $ make dev
+    ```
 
-## 相關範例
+3. 安裝 PHP 相關套件
+    ```bash
+        $ make install
+    ```
+
+4. 等待 E.L.K. 相關環境執行完畢 (約 1 ~ 5 分鐘)
+
+5. 進入 Kibana 查看網站是否正常執行 <br>
+`http://127.0.0.1:{KB_PORT}/`
+
+    KB_PORT 預設值: 5601
+
+6. `Management` 分頁 找到 Kibana `Index Patterns` 連結
+
+![image](https://github.com/andykuen/Docker-ELKonLaravel/blob/master/assets/images/kibana_01.png)
+
+7. 設定 E.L.K. index 資訊
+
+![image](https://github.com/andykuen/Docker-ELKonLaravel/blob/master/assets/images/kibana_02.png)
+
+![image](https://github.com/andykuen/Docker-ELKonLaravel/blob/master/assets/images/kibana_03.png)
+
+8. `Discover` 分頁 即可看到相關資訊。
+
+![image](https://github.com/andykuen/Docker-ELKonLaravel/blob/master/assets/images/kibana_04.png)
+
+## 新增一筆資料
+
+### URL
+[`POST`] `http://127.0.0.1:{APP_PORT}/api/log`
+
+### BODY (application/json)
+```JSON
+{
+    "msg": "你想要的內容"
+}
+```
diff --git a/app/Http/Controllers/ExampleController.php b/app/Http/Controllers/ExampleController.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Http\Request;
+
+class ExampleController extends Controller
+{
+    function createLog(Request $request){
+        \Log::info($request->input('msg', null));
+        return response('OK', 200);
+    }
+}
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -44,7 +44,7 @@ services:
     volumes:
       - ./ELK/logstash/pipeline:/usr/share/logstash/pipeline:ro
       - ./ELK/logstash/config/logstash.yml:/usr/share/logstash/config/logstash.yml:ro
-      - ./ELK/logstash/inputFile/:/home/inputFile
+      - ./storage/logs/:/home/inputFile
     networks:
       - LAN
 

diff --git a/images/kibana_01.png b/images/kibana_01.png
diff --git a/images/kibana_02.png b/images/kibana_02.png
diff --git a/images/kibana_03.png b/images/kibana_03.png
diff --git a/images/kibana_04.png b/images/kibana_04.png
diff --git a/makefile b/makefile
@@ -12,3 +12,6 @@ del: .docker-down
 
 .docker-down:
 	docker-compose down
+
+install:
+	docker exec -it ${APP_NAME} composer install
diff --git a/readme 拷貝.md b/readme 拷貝.md
diff --git a/routes/api.php b/routes/api.php
@@ -16,3 +16,5 @@
 Route::middleware('auth:api')->get('/user', function (Request $request) {
     return $request->user();
 });
+
+Route::post('/log', 'ExampleController@createLog');
diff --git a/storage/logs/.gitignore b/storage/logs/.gitignore
@@ -1,2 +1,3 @@
 *
 !.gitignore
+!laravel-2019-09-27.log
diff --git a/storage/logs/laravel-2019-09-27.log b/storage/logs/laravel-2019-09-27.log
@@ -0,0 +1 @@
+[2019-09-27 04:50:37] local.INFO: Hello Word