Constructor
new LoggingBunyan(optionsopt)
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
Properties
|
Examples
Import the client library
```
const {LoggingBunyan} = require('@google-cloud/logging-bunyan');
```
Create a client that uses <a href="https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application">Application Default Credentials (ADC)</a>:
```
const loggingBunyan = new
LoggingBunyan();
```
Create a client with <a href="https://cloud.google.com/docs/authentication/production#obtaining_and_providing_service_account_credentials_manually">explicit credentials</a>:
```
const loggingBunyan = new LoggingBunyan({
projectId: 'your-project-id',
keyFilename: '/path/to/keyfile.json'
});
```
const bunyan = require('bunyan');
// Imports the Google Cloud client library for Bunyan
const {LoggingBunyan} = require('@google-cloud/logging-bunyan');
// Creates a Bunyan Cloud Logging client
const loggingBunyan = new LoggingBunyan();
// Create a Bunyan logger that streams to Cloud Logging
// Logs will be written to: "projects/YOUR_PROJECT_ID/logs/bunyan_log"
const logger = bunyan.createLogger({
// The JSON payload of the log as it appears in Cloud Logging
// will contain "name": "my-service"
name: 'my-service',
streams: [
// Log to the console at 'info' and above
{stream: process.stdout, level: 'info'},
// And log to Cloud Logging, logging at 'info' and above
loggingBunyan.stream('info'),
],
});
// Writes some log entries
logger.error('warp nacelles offline');
logger.info('shields at 99%');
Members
LOGGING_SAMPLED_KEY
Value: logging.googleapis.com/trace_sampled
LOGGING_SPAN_KEY
Value: logging.googleapis.com/spanId
LOGGING_TRACE_KEY
Value: logging.googleapis.com/trace
Methods
_write()
Relay a log entry to the logging agent. This is called by bunyan through Writable#write.
_writeCall(entries, callback)
A helper function to make a write call
Parameters:
Name | Type | Description |
---|---|---|
entries |
The entries to be written |
|
callback |
The callback supplied by Writable.write |
_writev()
Relay an array of log entries to the logging agent. This is called by bunyan through Writable#write.
formatEntry_()
Format a bunyan record into a Stackdriver log entry.
generateCallback(callback)
Creates a combined callback which calls the this.defaultCallback and the Writable.write supplied callback
Parameters:
Name | Type | Description |
---|---|---|
callback |
The callback function provided by Writable |
Returns:
Type | Description |
---|---|
Combined callback which executes both, this.defaultCallback and one supplied by Writable.write |
getNodejsLibraryVersion()
Method used to retrieve the current logging-bunyan library version stored in NODEJS_BUNYAN_DEFAULT_LIBRARY_VERSION
Returns:
Type | Description |
---|---|
The version of this library |
stream()
Convenience method that Builds a bunyan stream object that you can put in the bunyan streams list.