Skip to content

Allow to tune down the logging on console. #481

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

Closed
pilhuhn wants to merge 1 commit into from
Closed

Allow to tune down the logging on console. #481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions ...dule/patternfly-docs/content/extensions/chatbot/examples/Analytics/Analytics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Note that user code only interacts with:

```nolive
const initProps: InitProps = {
verbose: false,
segmentKey: 'TODO-key', // TODO add your key here
// segmentCdn: 'https://my.org/cdn', // Set up segment cdn (optional)
// segmentIntegrations: { // Provide Segment integrations (optional)
Expand All @@ -57,6 +58,8 @@ const initProps: InitProps = {
};
```

Note, that there is also a key `verbose` that allows you to enable debugging output on web-browser console. By default, this is set to `false`.
Copy link
Copy Markdown
Contributor

@edonehoo edonehoo Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Note, that there is also a key `verbose` that allows you to enable debugging output on web-browser console. By default, this is set to `false`.
- **Note:** To enable output debugging via the web-browser console, set the `verbose` key to `true`. By default, this is set to `false`.

just the same suggestions I made in #492

Copy link
Copy Markdown
Collaborator Author

@pilhuhn pilhuhn Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. 492 contains this PR. I originally thought the "more harmless" one could go in the 2.2.0 release.


1. Once this is done, you can create an instance of the `trackingAPI` and start sending events.

```nolive
Expand Down
1 change: 1 addition & 0 deletions packages/module/patternfly-docs/content/extensions/chatbot/examples/demos/Chatbot.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ export default MessageLoading;
const date = new Date();

const initProps: InitProps = {
verbose: false,
segmentKey: 'TODO-key', // TODO add your key here
posthogKey: 'TODO-key',
umamiKey: 'TODO-key',
Expand Down
25 changes: 17 additions & 8 deletions packages/module/src/tracking/console_tracking_provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,35 @@ import { TrackingSpi } from './tracking_spi';
import { TrackingApi, TrackingEventProperties } from './tracking_api';

export class ConsoleTrackingProvider implements TrackingSpi, TrackingApi {
private verbose = false;
trackPageView(url: string | undefined) {
// eslint-disable-next-line no-console
console.log('ConsoleProvider pageView', url);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('ConsoleProvider pageView ', url);
}
}
// eslint-disable-next-line @typescript-eslint/no-empty-function
registerProvider(): void {}

initialize(): void {
// eslint-disable-next-line no-console
console.log('ConsoleProvider initialize');
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('ConsoleProvider initialize');
}
}

identify(userID: string): void {
// eslint-disable-next-line no-console
console.log('ConsoleProvider identify', userID);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('ConsoleProvider identify ', userID);
}
}

trackSingleItem(item: string, properties?: TrackingEventProperties): void {
// eslint-disable-next-line no-console
console.log('ConsoleProvider: ' + item, properties);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('ConsoleProvider: ' + item, properties);
}
}

getKey(): string {
Expand Down
25 changes: 17 additions & 8 deletions packages/module/src/tracking/posthog_tracking_provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ import { TrackingApi, TrackingEventProperties } from './tracking_api';
import { InitProps, TrackingSpi } from './tracking_spi';

export class PosthogTrackingProvider implements TrackingSpi, TrackingApi {
private verbose = false;
getKey(): string {
return 'posthogKey';
}

initialize(props: InitProps): void {
// eslint-disable-next-line no-console
console.log('PosthogProvider initialize');
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('PosthogProvider initialize');
}
const posthogKey = props.posthogKey as string;

posthog.init(posthogKey, {
Expand All @@ -22,21 +25,27 @@ export class PosthogTrackingProvider implements TrackingSpi, TrackingApi {
}

identify(userID: string): void {
// eslint-disable-next-line no-console
console.log('PosthogProvider userID: ' + userID);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('PosthogProvider userID: ' + userID);
}
posthog.identify(userID);
}

trackPageView(url: string | undefined): void {
// eslint-disable-next-line no-console
console.log('PostHogProvider url', url);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('PostHogProvider url', url);
}
// TODO posthog seems to record that automatically.
// How to not clash with this here? Just leave as no-op?
}

trackSingleItem(item: string, properties?: TrackingEventProperties): void {
// eslint-disable-next-line no-console
console.log('PosthogProvider: trackSingleItem' + item, properties);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('PosthogProvider: trackSingleItem' + item, properties);
}
posthog.capture(item, { properties });
}
}
25 changes: 17 additions & 8 deletions packages/module/src/tracking/segment_tracking_provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@ import { InitProps, TrackingSpi } from './tracking_spi';

export class SegmentTrackingProvider implements TrackingSpi, TrackingApi {
private analytics: AnalyticsBrowser | undefined;
private verbose = false;
getKey(): string {
return 'segmentKey';
}

initialize(props: InitProps): void {
// eslint-disable-next-line no-console
console.log('SegmentProvider initialize');
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('SegmentProvider initialize');
}
const segmentKey = props.segmentKey as string;

// We need to create an object here, as ts lint is unhappy otherwise
Expand All @@ -33,16 +36,20 @@ export class SegmentTrackingProvider implements TrackingSpi, TrackingApi {
}

identify(userID: string): void {
// eslint-disable-next-line no-console
console.log('SegmentProvider userID: ' + userID);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('SegmentProvider userID: ' + userID);
}
if (this.analytics) {
this.analytics.identify(userID);
}
}

trackPageView(url: string | undefined): void {
// eslint-disable-next-line no-console
console.log('SegmentProvider url', url);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('SegmentProvider url', url);
}
if (this.analytics) {
if (url) {
this.analytics.page(url);
Expand All @@ -53,8 +60,10 @@ export class SegmentTrackingProvider implements TrackingSpi, TrackingApi {
}

trackSingleItem(item: string, properties?: TrackingEventProperties): void {
// eslint-disable-next-line no-console
console.log('SegmentProvider: trackSingleItem' + item, properties);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('SegmentProvider: trackSingleItem' + item, properties);
}
if (this.analytics) {
this.analytics.track(item, { properties });
}
Expand Down
8 changes: 6 additions & 2 deletions packages/module/src/tracking/tracking_spi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
import { TrackingApi, TrackingEventProperties } from './tracking_api';

export interface InitProps {
[key: string]: string | number | boolean;
interface BaseProps {
verbose: boolean;
}

export type InitProps = {
[key: string]: string | number | boolean;
} & BaseProps;

export interface TrackingSpi extends TrackingApi {
// Return a key in InitProps to check if the provided should be enabled
getKey: () => string;
Expand Down
26 changes: 18 additions & 8 deletions packages/module/src/tracking/umami_tracking_provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@ declare global {
}

export class UmamiTrackingProvider implements TrackingSpi, TrackingApi {
private verbose = false;
getKey(): string {
return 'umamiKey';
}

initialize(props: InitProps): void {
// eslint-disable-next-line no-console
console.log('UmamiProvider initialize');
this.verbose = props.verbose;
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('UmamiProvider initialize');
}
const umamiKey = props.umamiKey as string;
const hostUrl = props.umamiHostUrl as string;

Expand All @@ -35,20 +39,26 @@ export class UmamiTrackingProvider implements TrackingSpi, TrackingApi {
}

identify(userID: string): void {
// eslint-disable-next-line no-console
console.log('UmamiProvider userID: ' + userID);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('UmamiProvider userID: ' + userID);
}
window.umami?.identify({ userID });
}

trackPageView(url: string | undefined): void {
// eslint-disable-next-line no-console
console.log('UmamiProvider url', url);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('UmamiProvider url', url);
}
window.umami?.track({ url });
}

trackSingleItem(item: string, properties?: TrackingEventProperties): void {
// eslint-disable-next-line no-console
console.log('UmamiProvider: trackSingleItem' + item, properties);
if (this.verbose) {
// eslint-disable-next-line no-console
console.log('UmamiProvider: trackSingleItem' + item, properties);
}
window.umami?.track(item, properties);
}
}