Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

basic enhancements for import logging #196056

Merged
merged 11 commits into from
Nov 1, 2024
Merged

basic enhancements for import logging #196056

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b3b16dd
basic enhancements for import logging
kyracho Oct 14, 2024
7f01cb5
Merge branch 'main' into enhance_import_logging
elasticmachine Oct 16, 2024
dee4e6a
move logging onto importSavedObjectsFromStream
kyracho Oct 26, 2024
4d93dce
adjust unit test for changes
kyracho Oct 26, 2024
05d6df7
fix formatting issues for eslintprettier/prettier
kyracho Oct 27, 2024
c44e2ce
fix unit test
kyracho Oct 28, 2024
0a2abc9
fix integration test to use existing mock logger instead of custom
kyracho Oct 28, 2024
80893e1
Merge branch 'main' into enhance_import_logging
kyracho Oct 28, 2024
ad45ea3
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Oct 28, 2024
3113d27
Merge branch 'main' into enhance_import_logging
afharo Oct 30, 2024
70805ee
Merge branch 'main' into enhance_import_logging
elasticmachine Oct 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion .../core-saved-objects-import-export-server-internal/src/import/import_saved_objects.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,17 @@ describe('#importSavedObjectsFromStream', () => {
let savedObjectsClient: jest.Mocked<SavedObjectsClientContract>;
let typeRegistry: jest.Mocked<ISavedObjectTypeRegistry>;
const namespace = 'some-namespace';

const mockLog = {
kyracho marked this conversation as resolved.
Show resolved Hide resolved
trace: jest.fn(),
debug: jest.fn(),
info: jest.fn(),
warn: jest.fn(),
fatal: jest.fn(),
log: jest.fn(),
error: jest.fn(),
get: jest.fn(),
isLevelEnabled: jest.fn(),
};
const setupOptions = ({
createNewCopies = false,
getTypeImpl = (type: string) =>
Expand Down Expand Up @@ -102,6 +112,7 @@ describe('#importSavedObjectsFromStream', () => {
createNewCopies,
importHooks,
managed,
log: mockLog,
};
};
const createObject = ({
Expand Down
11 changes: 10 additions & 1 deletion ...jects/core-saved-objects-import-export-server-internal/src/import/import_saved_objects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import type {
ISavedObjectTypeRegistry,
SavedObjectsImportHook,
} from '@kbn/core-saved-objects-server';
import type { Logger } from '@kbn/logging';
import {
checkReferenceOrigins,
validateReferences,
Expand Down Expand Up @@ -59,6 +60,7 @@ export interface ImportSavedObjectsOptions {
* If provided, Kibana will apply the given option to the `managed` property.
*/
managed?: boolean;
log: Logger;
}

/**
Expand All @@ -79,7 +81,9 @@ export async function importSavedObjectsFromStream({
refresh,
compatibilityMode,
managed,
log,
}: ImportSavedObjectsOptions): Promise<SavedObjectsImportResponse> {
log.debug(`Importing with overwrite ${overwrite ? 'enabled' : 'disabled'} and size limit ${objectLimit}`);
let errorAccumulator: SavedObjectsImportFailure[] = [];
const supportedTypes = typeRegistry.getImportableAndExportableTypes().map((type) => type.name);

Expand All @@ -90,6 +94,7 @@ export async function importSavedObjectsFromStream({
supportedTypes,
managed,
});
log.debug(`Importing types: ${[...new Set(collectSavedObjectsResult.collectedObjects.map((obj) => obj.type))].join(', ')}`);
errorAccumulator = [...errorAccumulator, ...collectSavedObjectsResult.errors];
// Map of all IDs for objects that we are attempting to import, and any references that are not included in the read stream;
// each value is empty by default
Expand Down Expand Up @@ -197,7 +202,11 @@ export async function importSavedObjectsFromStream({
objects: createSavedObjectsResult.createdObjects,
importHooks,
});

if (errorAccumulator.length > 0) {
log.error(`Failed to import saved objects. ${errorAccumulator.length} errors: ${JSON.stringify(errorAccumulator)}`);
} else {
log.info(`Successfully imported ${createSavedObjectsResult.createdObjects.length} saved objects.`);
}
return {
successCount: createSavedObjectsResult.createdObjects.length,
success: errorAccumulator.length === 0,
Expand Down
4 changes: 2 additions & 2 deletions ...cts/core-saved-objects-import-export-server-internal/src/import/saved_objects_importer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ export class SavedObjectsImporter implements ISavedObjectsImporter {
compatibilityMode,
managed,
}: SavedObjectsImportOptions): Promise<SavedObjectsImportResponse> {
this.#log.debug('Starting the import process');
return importSavedObjectsFromStream({
readStream,
createNewCopies,
Expand All @@ -75,7 +74,8 @@ export class SavedObjectsImporter implements ISavedObjectsImporter {
typeRegistry: this.#typeRegistry,
importHooks: this.#importHooks,
managed,
});
log: this.#log,
})
}

public resolveImportErrors({
Expand Down