mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
* fix after rebase * new release strategy for ng next Signed-off-by: eromano <eugenioromano16@gmail.com> * peer dep Signed-off-by: eromano <eugenioromano16@gmail.com> * Angular 14 fix unit test and storybook Signed-off-by: eromano <eugenioromano16@gmail.com> fix after rebase Signed-off-by: eromano <eugenioromano16@gmail.com> update pkg.json Signed-off-by: eromano <eugenioromano16@gmail.com> missing dep Signed-off-by: eromano <eugenioromano16@gmail.com> Fix mistake and missing code Dream....build only affected libs Add utility run commands * Use nx command to run affected tests * Fix nx test core fix content tests Run unit with watch false core test fixes reduce test warnings Fix process cloud unit Fix adf unit test Fix lint process cloud Disable lint next line Use right core path Fix insights unit fix linting insights Fix process-services unit fix the extensions test report fix test warnings Fix content unit Fix bunch of content unit * Produce an adf alpha of 14 * hopefully fixing the content * Push back the npm publish * Remove flaky unit * Fix linting * Make the branch as root * Get rid of angualar13 * Remove the travis depth * Fixing version for npm * Enabling cache for unit and build * Fix scss for core and paths Copy i18 and asset by using ng-packager Export the theming alias and fix path Use ng-package to copy assets process-services-cloud Use ng-package to copy assets process-services Use ng-package to copy assets content-services Use ng-package to copy assets insights * feat: fix api secondary entry point * fix storybook rebase * Move dist under dist/libs from lib/dist * Fix the webstyle * Use only necessary nrwl deps and improve lint * Fix unit for libs * Convert lint.sh to targets - improve performance * Use latest of angular * Align alfresco-js-api Signed-off-by: eromano <eugenioromano16@gmail.com> Co-authored-by: eromano <eugenioromano16@gmail.com> Co-authored-by: Mikolaj Serwicki <mikolaj.serwicki@hyland.com> Co-authored-by: Tomasz <tomasz.gnyp@hyland.com>
147 lines
5.1 KiB
Markdown
147 lines
5.1 KiB
Markdown
---
|
|
Title: Log Service
|
|
Added: v2.0.0
|
|
Status: Active
|
|
Last reviewed: 2018-06-08
|
|
---
|
|
|
|
# [Log Service](lib/core/src/lib/services/log.service.ts "Defined in log.service.ts")
|
|
|
|
Provides log functionality.
|
|
|
|
## Basic Usage
|
|
|
|
**app.component.ts**
|
|
|
|
```ts
|
|
import { LogService } from '@alfresco/adf-core';
|
|
|
|
@Component({...})
|
|
export class AppComponent {
|
|
|
|
constructor(logService: LogService) {
|
|
}
|
|
|
|
myMethod(){
|
|
this.logService.error('My error');
|
|
this.logService.trace('My trace')
|
|
this.logService.debug('My debug')
|
|
this.logService.info('My info')
|
|
this.logService.warn('My warn')
|
|
}
|
|
|
|
}
|
|
```
|
|
|
|
```ts
|
|
import { LogService } from '@alfresco/adf-core';
|
|
|
|
@Component({...})
|
|
export class AppComponent {
|
|
|
|
constructor(logService: LogService, myIntegrationService: MyIntegrationService)) {
|
|
logService.onMessage.subscribe((message) => {
|
|
myIntegrationService.send(message.text,message.type);
|
|
});
|
|
}
|
|
}
|
|
```
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **assert**(test?: `boolean`, message?: `string`, optionalParams: `any[]`)<br/>
|
|
Logs a message if a boolean test fails.
|
|
- _test:_ `boolean` - (Optional) Test value (typically a boolean expression)
|
|
- _message:_ `string` - (Optional) Message to show if test is false
|
|
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
|
|
- **debug**(message?: `any`, optionalParams: `any[]`)<br/>
|
|
Logs a message at the "DEBUG" level.
|
|
- _message:_ `any` - (Optional) Message to log
|
|
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
|
|
- **error**(message?: `any`, optionalParams: `any[]`)<br/>
|
|
Logs a message at the "ERROR" level.
|
|
- _message:_ `any` - (Optional) Message to log
|
|
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
|
|
- **getLogLevel**(level: `string`): [`LogLevelsEnum`](lib/core/src/lib/models/log-levels.model.ts)<br/>
|
|
Converts a log level name string into its numeric equivalent.
|
|
- _level:_ `string` - Level name
|
|
- **Returns** [`LogLevelsEnum`](lib/core/src/lib/models/log-levels.model.ts) - Numeric log level
|
|
- **group**(groupTitle?: `string`, optionalParams: `any[]`)<br/>
|
|
Starts an indented group of log messages.
|
|
- _groupTitle:_ `string` - (Optional) Title shown at the start of the group
|
|
- _optionalParams:_ `any[]` - Interpolation values for the title in "printf" format
|
|
- **groupEnd**()<br/>
|
|
Ends a indented group of log messages.
|
|
- **info**(message?: `any`, optionalParams: `any[]`)<br/>
|
|
Logs a message at the "INFO" level.
|
|
- _message:_ `any` - (Optional) Message to log
|
|
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
|
|
- **log**(message?: `any`, optionalParams: `any[]`)<br/>
|
|
Logs a message at any level from "TRACE" upwards.
|
|
- _message:_ `any` - (Optional) Message to log
|
|
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
|
|
- **messageBus**(text: `string`, logLevel: `string`)<br/>
|
|
Triggers notification callback for log messages.
|
|
- _text:_ `string` - Message text
|
|
- _logLevel:_ `string` - Log level for the message
|
|
- **trace**(message?: `any`, optionalParams: `any[]`)<br/>
|
|
Logs a message at the "TRACE" level.
|
|
- _message:_ `any` - (Optional) Message to log
|
|
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
|
|
- **warn**(message?: `any`, optionalParams: `any[]`)<br/>
|
|
Logs a message at the "WARN" level.
|
|
- _message:_ `any` - (Optional) Message to log
|
|
- _optionalParams:_ `any[]` - Interpolation values for the message in "printf" format
|
|
|
|
## Details
|
|
|
|
### Log levels
|
|
|
|
There are 6 levels of logs that you can use:
|
|
|
|
| Name | Level |
|
|
| ---- | ----- |
|
|
| TRACE | 5 |
|
|
| DEBUG | 4 |
|
|
| INFO | 3 |
|
|
| WARN | 2 |
|
|
| ERROR | 1 |
|
|
| SILENT | 0 |
|
|
|
|
You can set the default log level using the **_logLevel_** property in `app.config.json`.
|
|
The factory setting for this property is `TRACE`.
|
|
|
|
For example, you can set the default log level to `WARNING` as follows:
|
|
|
|
**app.config.json**
|
|
|
|
```json
|
|
{
|
|
"logLevel": "WARN"
|
|
}
|
|
```
|
|
|
|
### Log message bus
|
|
|
|
The [log service](log.service.md) also provides an
|
|
[`Observable`](http://reactivex.io/documentation/observable.html) called `_onMessage_`
|
|
that you can subscribe to if you want to receive all the log messages.
|
|
The message object passed as a parameter to the `onMessage` handler has the following format:
|
|
|
|
```ts
|
|
{
|
|
text: "Message log text"
|
|
type: "ERROR|DEBUG|INFO|LOG|TRACE|WARN|ASSERT"
|
|
}
|
|
```
|
|
|
|
### Using the log to feed analytics
|
|
|
|
You can pass the log output to an analytics system to collect error and assertion data
|
|
from apps as they run. This can help you spot which problems users are running into most
|
|
often and the situations in which they occur. See the tutorial about
|
|
[integrating the log service with analytics](https://community.alfresco.com/community/application-development-framework/blog/2018/05/01/how-to-integrate-adf-log-service-with-mixpanel-analytics-service)
|
|
on the Alfresco Community site for further information.
|