paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 47 Packages Projects Releases Wiki Activity

Merge pull request #16200 from backstage/rugvip/nometa

Browse Source 
backend-plugin-api: inlined LogMeta type
This commit is contained in:
Patrik Oldsberg
2023-02-07 14:20:34 +01:00
committed by GitHub
parent c88fe4e99a c769924e85
commit e968cc164d
13 changed files with 212 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-plugin-api/api-report.md
+6 -10
View File
@@ -8,6 +8,7 @@
import { Config } from '@backstage/config';
import { Handler } from 'express';
import { IdentityApi } from '@backstage/plugin-auth-node';
import { JsonObject } from '@backstage/types';
import { JsonValue } from '@backstage/types';
import { Knex } from 'knex';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
@@ -311,22 +312,17 @@ export interface LifecycleServiceShutdownOptions {
// @public
export interface LoggerService {
// (undocumented)
child(meta: LogMeta): LoggerService;
child(meta: JsonObject): LoggerService;
// (undocumented)
debug(message: string, meta?: Error | LogMeta): void;
debug(message: string, meta?: Error | JsonObject): void;
// (undocumented)
error(message: string, meta?: Error | LogMeta): void;
error(message: string, meta?: Error | JsonObject): void;
// (undocumented)
info(message: string, meta?: Error | LogMeta): void;
info(message: string, meta?: Error | JsonObject): void;
// (undocumented)
warn(message: string, meta?: Error | LogMeta): void;
warn(message: string, meta?: Error | JsonObject): void;
}
// @public (undocumented)
export type LogMeta = {
[name: string]: unknown;
};
// @public (undocumented)
export interface PermissionsService extends PermissionEvaluator {}
packages/backend-plugin-api/src/services/definitions/LoggerService.ts
+6 -9
View File
@@ -14,10 +14,7 @@
* limitations under the License.
*/
/**
* @public
*/
export type LogMeta = { [name: string]: unknown };
import { JsonObject } from '@backstage/types';
/**
* A service that provides a logging facility.
@@ -25,10 +22,10 @@ export type LogMeta = { [name: string]: unknown };
* @public
*/
export interface LoggerService {
error(message: string, meta?: Error | LogMeta): void;
warn(message: string, meta?: Error | LogMeta): void;
info(message: string, meta?: Error | LogMeta): void;
debug(message: string, meta?: Error | LogMeta): void;
error(message: string, meta?: Error | JsonObject): void;
warn(message: string, meta?: Error | JsonObject): void;
info(message: string, meta?: Error | JsonObject): void;
debug(message: string, meta?: Error | JsonObject): void;
child(meta: LogMeta): LoggerService;
child(meta: JsonObject): LoggerService;
}
packages/backend-plugin-api/src/services/definitions/index.ts
+1 -1
View File
@@ -30,7 +30,7 @@ export type {
LifecycleServiceShutdownHook,
LifecycleServiceShutdownOptions,
} from './LifecycleService';
export type { LoggerService, LogMeta } from './LoggerService';
export type { LoggerService } from './LoggerService';
export type { PermissionsService } from './PermissionsService';
export type { PluginMetadataService } from './PluginMetadataService';
export type { RootHttpRouterService } from './RootHttpRouterService';