Feature(CORE): Activity log extension

[onlyjackfrost]

Description

Add a activity log extension to send activity log like incoming request information and cache refreshing result.
Activity logs aim to provide a more specific and accurate information compared to the access log or debug logger stdout.

How to use

# vulcan.yaml
activity-log:
    enabled: true
    options:
        http-logger:
            connection:
                ssl: boolean. # use https or not
                host: string
                port: integer
                path: "url path"

After you set your project config, vulcan server will send activity log to remote server asynchronously when cache refreshing job is done and after processed an API request.

A cache refreshing activity log will contain info

logTime(timestamp in UTC) -- the time that refresh job started
urlPath -- indicate which API it belong
sql -- the sql statement that will be executed 
refreshResult -- Enum(success, failed), the result of refresh job

In an API request activity log will contain info

logTime(timestamp in UTC) -- the timestamp that server received the request
duration(ms) -- the approximate time that server handled the API request
method -- the request method
url -- the request url
ip -- the original IP
header -- the request headers
params -- the request params
query -- the request query parameters
status -- the response HTTP status
error -- the error message that VulcanSQL provided
user -- the attribute that the client user have (gain after authenticate)

Test

unit tests
Labs:
manually create a koa server on localhost with a router "(POST)/test"
vulcan.yaml:

...
activity-log:
  enabled: true
  options:
    http-logger:  
      connection:
        host: localhost
        port: 8080
        path: test

• Activity log should be send after refresh job done

• Activity log should be send after processed API request
  

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
vulcan-sql-document	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 18, 2023 9:26am

[codecov]

Codecov Report

Patch coverage is 88.99% of modified lines.

Files Changed	Coverage
packages/core/src/containers/types.ts	ø
...kages/core/src/lib/cache-layer/cacheLayerLoader.ts	ø
...c/lib/template-engine/compiler-environment/base.ts	ø
...-authenticator-canner/src/lib/authenticator/pat.ts	ø
packages/core/src/models/extensions/logger.ts	85.00%
...es/core/src/lib/cache-layer/cacheLayerRefresher.ts	85.18%
packages/core/src/lib/loggers/httpLogger.ts	88.88%
.../serve/src/lib/middleware/activityLogMiddleware.ts	89.28%
packages/core/src/containers/modules/extension.ts	100.00%
packages/core/src/index.ts	100.00%
... and 5 more

📢 Thoughts on this report? Let us know!.

[kokokuo]

Beside some questions and suggestions, other LGTM

[kokokuo]

What is the comment? Seems no fn ?

[kokokuo]

Why does here use the functional expression repsentation ( xxx = () => {} )? Is the reason to do it?

[kokokuo]

Same as above.

[kokokuo]

Just curious seems you have provided a function called getUrl in utils and here you also create the same name method, but also the same code ( not using the header ), so why does not use the getUrl in utils directly?

const url = getUrl(connection as ConnectionConfig);

[kokokuo]

You have added the ?, is means undefined, so actually, you don't need to write again by undefined.

[kokokuo]

Same as above of path

[kokokuo]

LGTM 👍

[kokokuo]

Optional: Suggest renaming LoadCacheAndSendActivityLog, if you are available