mocha-stackdriver-reporter
v0.1.0
Published
Mocha reporter to log test results with Google Cloud Logging API
Downloads
11
Maintainers
Readme
Mocha Stackdriver Reporter
Mocha reporter using the Google Cloud Logging API.
Install
npm install mocha-stackdriver-reporter --save-dev
Options
projectId
: Google Cloud Project ID.logName
: Log identifier; gets merged withprojectId
into e.g.projects/test123/logs/my-function%2Fwith-name
. Note how last part is URL encoded. This is automatically taken care when using alogName
with/
in the name, e.g.my-function/with-name
.entryMetadata
: Metadata for log entries.
CLI
Run mocha with reporter configured:
mocha --reporter mocha-stackdriver-reporter --reporter-options projectId=myGcpProjectId,logName=myLogName
Entry metadata can be set with environment variable ENTRY_METADATA
:
ENTRY_METADATA='{ "resource": { "labels": { "function_name": "my-cloud-function", "project_id": "my-project-id", "region": "my-region" }, "type": "cloud_function" } }' \
mocha --reporter mocha-stackdriver-reporter --reporter-options projectId=my-project-id,logName=my-log-name
Code
const Mocha = require("mocha");
const StackdriverReporter = require("mocha-stackdriver-reporter");
const mocha = new Mocha();
mocha.reporter(StackdriverReporter, {
projectId: "my-project-id",
logName: "my-log-name",
entryMetadata: {
resource: {
labels: {
function_name: "my-cloud-function",
project_id: "my-project-id",
region: "my-region",
},
type: "cloud_function",
},
},
alsoConsole: false, // (optional) if true, also output result to console
onlyConsole: false, // (optional) if true, only output result to console
});