https://github.com/dvsa/azure-logger
https://github.com/dvsa/azure-logger
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dvsa/azure-logger
- Owner: dvsa
- License: mit
- Created: 2020-02-19T13:36:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T10:12:22.000Z (over 1 year ago)
- Last Synced: 2024-11-18T11:35:59.390Z (over 1 year ago)
- Language: TypeScript
- Size: 1.85 MB
- Stars: 0
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Azure Logger
Winston Logger with a custom Azure Application Insights Transport
### Logging levels
* critical
* error
* warning
* event
* request
* dependency
* security
* audit
* info
* debug
## Installation
If using npm:
```
npm install @dvsa/azure-logger
```
or if using Yarn
```
yarn add @dvsa/azure-logger
```
Specify the environment variables in a .env file, for example
```
LOG_LEVEL=event
NODE_ENV=development
APPLICATIONINSIGHTS_CONNECTION_STRING={APPLICATION_INSIGHTS_CONNECTION_STRING}
```
## Example Use:
1) Create a file logger.ts and export the azure logger from it, instantiating it with the project and component names.
```typescript
import { Logger } from '@dvsa/azure-logger';
export default new Logger('ftts', 'ftts-location-api');
```
2) For Azure Functions, two wrappers are provided to enable auto correlation of all logs and telemetry including external requests and dependencies.
For HTTP triggers use the `httpTriggerContextWrapper` with req passed in. Use `nonHttpTriggerContextWrapper` for all other trigger types.
For example, wrap a time trigger function in your function index file like so:
```typescript
import { nonHttpTriggerContextWrapper } from '@dvsa/azure-logger';
import { AzureFunction, Context } from '@azure/functions';
const myTimeTrigger: AzureFunction = async (): Promise => {
// do something
};
export default async (context: Context): Promise => nonHttpTriggerContextWrapper(myTimeTrigger, context);
```
Request and dependency log methods are still provided for manual tracing if it is needed e.g. for service bus correlation.
These require context to be passed in to fetch the correct trace ids.
3) Whenever you want to log an item import the logger.ts file.
```typescript
import logger from './logger';
function getData(): void {
try {
// Do calculations
} catch(error) {
logger.error(error);
}
}
```
## APPLICATIONINSIGHTS_CONNECTION_STRING
When using an Azure function app the following environment variable must be present and contain the connection string for the application insights instance you wish to use.
APPLICATIONINSIGHTS_CONNECTION_STRING