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

Jump to bottom

Fixes search usage telemetry #1427

Merged
merged 5 commits into from
Apr 7, 2022
Merged

Fixes search usage telemetry #1427

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ead66f
fix search usage telemetry
Flyingliuhub Apr 5, 2022
66873a7
add unit tests and fixes comments
Flyingliuhub Apr 6, 2022
d22f483
add newline at the end of usage.test.ts
Flyingliuhub Apr 6, 2022
86196c8
add docker var change
Flyingliuhub Apr 6, 2022
96b3fd4
update check configuration
Flyingliuhub Apr 7, 2022
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
6 changes: 5 additions & 1 deletion config/opensearch_dashboards.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,8 @@

# Set the value of this setting to true to capture region blocked warnings and errors
# for your map rendering services.
# map.showRegionBlockedWarning: false
# map.showRegionBlockedWarning: false

# Set the value of this setting to false to suppress search usage telemetry
# for reducing the load of OpenSearch cluster.
data.searchUsageTelemetry.enabled: false
Flyingliuhub marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions src/plugins/data/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ export const configSchema = schema.object({
}),
}),
}),
searchUsageTelemetry: schema.object({
Flyingliuhub marked this conversation as resolved.
Show resolved Hide resolved
enabled: schema.boolean({ defaultValue: false }),
}),
});

export type ConfigSchema = TypeOf<typeof configSchema>;
73 changes: 42 additions & 31 deletions src/plugins/data/server/search/collectors/usage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@
* under the License.
*/

import { CoreSetup } from 'opensearch-dashboards/server';
import { CoreSetup, PluginInitializerContext } from 'opensearch-dashboards/server';
import { first } from 'rxjs/operators';
import { Usage } from './register';
import { ConfigSchema } from '../../../config';

const SAVED_OBJECT_ID = 'search-telemetry';

Expand All @@ -38,44 +40,53 @@ export interface SearchUsage {
trackSuccess(duration: number): Promise<void>;
}

export function usageProvider(core: CoreSetup): SearchUsage {
export function usageProvider(
core: CoreSetup,
initializerContext: PluginInitializerContext<ConfigSchema>
Flyingliuhub marked this conversation as resolved.
Show resolved Hide resolved
): SearchUsage {
const getTracker = (eventType: keyof Usage) => {
return async (duration?: number) => {
const repository = await core
.getStartServices()
.then(([coreStart]) => coreStart.savedObjects.createInternalRepository());
const config = await initializerContext.config
.create<ConfigSchema>()
.pipe(first())
.toPromise();
Flyingliuhub marked this conversation as resolved.
Show resolved Hide resolved
if (config.searchUsageTelemetry.enabled) {
const repository = await core
.getStartServices()
.then(([coreStart]) => coreStart.savedObjects.createInternalRepository());

let attributes: Usage;
let doesSavedObjectExist: boolean = true;
let attributes: Usage;
Flyingliuhub marked this conversation as resolved.
Show resolved Hide resolved
let doesSavedObjectExist: boolean = true;

try {
const response = await repository.get<Usage>(SAVED_OBJECT_ID, SAVED_OBJECT_ID);
attributes = response.attributes;
} catch (e) {
doesSavedObjectExist = false;
attributes = {
successCount: 0,
errorCount: 0,
averageDuration: 0,
};
}
try {
const response = await repository.get<Usage>(SAVED_OBJECT_ID, SAVED_OBJECT_ID);
attributes = response.attributes;
} catch (e) {
doesSavedObjectExist = false;
attributes = {
successCount: 0,
errorCount: 0,
averageDuration: 0,
};
}

attributes[eventType]++;
attributes[eventType]++;

// Only track the average duration for successful requests
if (eventType === 'successCount') {
attributes.averageDuration =
((duration ?? 0) + (attributes.averageDuration ?? 0)) / (attributes.successCount ?? 1);
}
// Only track the average duration for successful requests
if (eventType === 'successCount') {
attributes.averageDuration =
((duration ?? 0) + (attributes.averageDuration ?? 0)) / (attributes.successCount ?? 1);
}

try {
if (doesSavedObjectExist) {
await repository.update(SAVED_OBJECT_ID, SAVED_OBJECT_ID, attributes);
} else {
await repository.create(SAVED_OBJECT_ID, attributes, { id: SAVED_OBJECT_ID });
try {
if (doesSavedObjectExist) {
await repository.update(SAVED_OBJECT_ID, SAVED_OBJECT_ID, attributes);
} else {
await repository.create(SAVED_OBJECT_ID, attributes, { id: SAVED_OBJECT_ID });
}
} catch (e) {
// Version conflict error, swallow
}
} catch (e) {
// Version conflict error, swallow
}
};
};
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/data/server/search/search_service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export class SearchService implements Plugin<ISearchSetup, ISearchStart> {
core: CoreSetup<{}, DataPluginStart>,
{ registerFunction, usageCollection }: SearchServiceSetupDependencies
): ISearchSetup {
const usage = usageCollection ? usageProvider(core) : undefined;
const usage = usageCollection ? usageProvider(core, this.initializerContext) : undefined;

const router = core.http.createRouter();
const routeDependencies = {
Expand Down