README

Install

Via Composer

$ composer require lokielse/laravel-sls

Config

Add following service providers into your providers array in config/app.php

Lokielse\LaravelSLS\LaravelSLSServiceProvider::class

Publish sls.php to config folder

php artisan vendor:publish --provider="Lokielse\LaravelSLS\LaravelSLSServiceProvider"

Replace Log alias in your config/app.php (Optional)

//'Log'               => Illuminate\Support\Facades\Log::class,
'Log'                 => Lokielse\LaravelSLS\Facades\WriterFacade::class,
'SLSLog'              => Lokielse\LaravelSLS\Facades\LogFacade::class,

Edit your .env file

ALIYUN_ACCESS_KEY_ID=...
ALIYUN_ACCESS_KEY_SECRET=...
# https://help.aliyun.com/document_detail/29008.html
# 如杭州公网 cn-hangzhou.log.aliyuncs.com
# 如杭州内网 cn-hangzhou-intranet.log.aliyuncs.com
SLS_ENDPOINT=cn-hangzhou.log.aliyuncs.com
SLS_PROJECT=test-project
SLS_STORE=test-store

You should update SLS_ENDPOINT to internal endpoint in production mode

Usage

First create a project and store at Aliyun SLS Console

Then update SLS_ENDPOINT, SLS_PROJECT, SLS_STORE in .env

Push a test message to queue

Log::info('Test Message', ['foobar'=>'2003']);

//or you can use `app('sls')` 

app('sls')->putLogs([
	'type' => 'test',
	'message' => json_encode(['This should use json_encode'])
]);

//or you can use `SLSLog` directly 

SLSLog::putLogs([
	'type' => 'test',
	'message' => json_encode(['This should use json_encode'])
]);

Security

Create RAM access control at Aliyun RAM Console

Create a custom policy such as AliyunSLSFullAccessFoobar

{
  "Version": "1",
  "Statement": [
	{
	  "Action": "log:*",
	  "Resource": [
		"acs:log:*:*:project/test-project/logstore/test-store",
	  ],
	  "Effect": "Allow"
	}
  ]
}

Create a user for you app such as foobar
Assign the policy AliyunSLSFullAccessFoobar to the user foobar
Create and get the AccessKeyId and AccessKeySecret for user foorbar
update QUEUE_SLS_ACCESS_KEY and QUEUE_SLS_ACCESS_SECRET in .env

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

lokielse / laravel-sls

Maintainers

Details