feat(perf): Add performance measuring api #117

TatianaFomina · 2025-03-15T16:03:30Z

Performance Monitoring API

This PR adds a new Performance Monitoring API to track application performance metrics.

Features

Track transactions and spans with timing data
Automatic span completion when transaction ends
Support for both browser and Node.js environments
Debug mode for development
Graceful cleanup on page unload/process exit

API

// Start a transaction
const transaction = hawk.startTransaction('page-load', {
  page: '/home',
  type: 'navigation'
});

// Create spans within transaction
const span = hawk.startSpan(transaction.id, 'api-call', {
  url: '/api/users'
});

// Finish span when operation completes
span.finish();

// Finish transaction
transaction.finish();

…and resource cleanup

README.md

src/catcher.ts

src/modules/performance.ts

…ampling

…saction generation

… send timeout logic

… spans and remove Transaction inheritance

…performance monitoring capabilities

… performance monitoring settings

…performance and utility modules

…ethod

README.md

src/catcher.ts

src/utils/get-timestamp.ts

src/modules/performance.ts

src/types/performance-message.ts

…ormance monitoring structure

…ch sending method to use setTimeout

…ant for the token and remove unused transaction generation buttons for improved clarity and performance.

…for transactions. Update documentation and README to reflect new settings, including changes to transaction filtering criteria. Remove unused demo elements from example HTML for improved clarity.

…sistency and improving documentation clarity. Update comments to enhance understanding of methods and parameters.

…pan and Transaction classes, including descriptions for properties and methods. Remove unused types from performance module and update imports for better clarity and organization.

…readability. Adjust formatting for better alignment and clarity, and update import statements for consistency.

neSpecc · 2025-03-17T20:02:32Z

src/modules/performance/index.ts

+   *
+   * @param transaction - Transaction to queue
+   */
+  public queueTransaction(transaction: Transaction): void {


Suggested change

public queueTransaction(transaction: Transaction): void {

public enqueueTransaction(transaction: Transaction): void {

neSpecc · 2025-03-17T20:05:55Z

src/modules/performance/index.ts

+    if (this.sendQueue.length > 0) {
+      void this.processSendQueue();
+    }
+  }


sendRetires should be cleared as well

neSpecc · 2025-03-17T20:11:46Z

src/modules/performance/index.ts

+   * @param p - Percentile to calculate (e.g., 50 for median, 95 for 95th percentile)
+   * @returns Percentile value
+   */
+  private percentile(sortedValues: number[], p: number): number {


move to util, please

neSpecc · 2025-03-17T20:12:09Z

src/modules/performance/index.ts

+   * @param p - Percentile to calculate (e.g., 50 for median, 95 for 95th percentile)
+   * @returns Percentile value
+   */
+  private percentile(sortedValues: number[], p: number): number {


maybe sorting should be a part of this method?

neSpecc · 2025-03-17T20:12:26Z

src/modules/performance/index.ts

+   * @param values - Array of numbers
+   * @returns Average value
+   */
+  private average(values: number[]): number {


create utility

neSpecc · 2025-03-17T20:13:02Z

src/modules/performance/index.ts

+
+        this.sendRetries.set(tx.id, retryCount);
+
+        const shouldRetry = retryCount <= MAX_SEND_RETRIES;


I think retrying should be a part of Transport

neSpecc · 2025-03-17T20:14:24Z

src/modules/performance/transaction.ts

+  /**
+   * Queues this transaction for sending to the server
+   */
+  private queueForSending(): void {


Suggested change

private queueForSending(): void {

private enqueueForSending(): void {

neSpecc · 2025-03-17T20:19:09Z

README.md

@@ -161,3 +161,154 @@ const hawk = new HawkCatcher({

 hawk.connectVue(Vue)
 ```
+
+## Performance Monitoring
+


explain what is Transaction and Span.

move API Reference on the first place

optimization explanation is a technical detail, so it should be placed after usage description

neSpecc · 2025-03-17T20:29:02Z

src/types/transaction.ts

+  /**
+   * Total number of transactions in this group
+   */
+  count: number;


move count under name

neSpecc · 2025-04-02T16:08:33Z

src/modules/performance/index.ts

+      token: this.token,
+      catcherType: 'performance',
+      payload: {
+        transactions,


lets rename to aggregatedTransactions

TatianaFomina added 4 commits March 15, 2025 17:20

Implement perf events

c022264

feat(performance): enhance performance monitoring with batch sending …

0bc0093

…and resource cleanup

Lint

767592b

Upd

ab1ab01

TatianaFomina changed the title ~~Feat/perf~~ feat(perf): Add performance measuring api Mar 15, 2025

Upd

751a048

neSpecc reviewed Mar 15, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

src/catcher.ts Outdated Show resolved Hide resolved

neSpecc reviewed Mar 15, 2025

View reviewed changes

TatianaFomina added 14 commits March 15, 2025 19:52

Upd api

5daeb4e

Remove traceId

b5d71c4

feat(performance): add performance monitoring

d708ebb

feat(performance): enhance performance monitoring configuration and s…

1c7a123

…ampling

feat(performance): add performance monitoring settings demo with tran…

2cabdaa

…saction generation

refactor(performance): simplify transaction queuing and remove unused…

a0d56bb

… send timeout logic

refactor(performance): update PerformancePayload interface to include…

933f7f9

… spans and remove Transaction inheritance

Lint

6c544bd

Fix

8309ae3

Review

d611f1d

feat(performance): introduce batch sending configuration and enhance …

2459f5d

…performance monitoring capabilities

feat(performance): add batch interval configuration and update UI for…

c1639ca

… performance monitoring settings

style: clean up code formatting and remove unnecessary whitespace in …

c8b37bc

…performance and utility modules

chore(performance): remove debugger statement from startTransaction m…

1e57084

…ethod

neSpecc requested changes Mar 15, 2025

View reviewed changes

neSpecc reviewed Mar 15, 2025

View reviewed changes

src/modules/performance.ts Outdated Show resolved Hide resolved

src/modules/performance.ts Outdated Show resolved Hide resolved

src/modules/performance.ts Outdated Show resolved Hide resolved

neSpecc reviewed Mar 15, 2025

View reviewed changes

src/types/performance-message.ts Outdated Show resolved Hide resolved

TatianaFomina added 5 commits March 16, 2025 11:55

Split

8e8d0f7

Review

efa12f9

feat(performance): update HawkCatcher initialization and enhance perf…

677fdaf

…ormance monitoring structure

fix(performance): correct transaction length reference and update bat…

1f1e758

…ch sending method to use setTimeout

Add doc

93fd56c

neSpecc and others added 14 commits March 16, 2025 15:49

Update performance-monitoring.md

846e864

Update performance-monitoring.md

e510e2a

Update performance-monitoring.md

cefde4d

Update performance-monitoring.md

e6885ca

Update respectively to docs

366ca89

Upd

936da97

Update readme

6ffcf16

Refactor HawkCatcher initialization in monitoring.html to use a const…

e007868

…ant for the token and remove unused transaction generation buttons for improved clarity and performance.

Merge branch 'master' into feat/perf

bbc9cea

Enhance performance monitoring by adding critical duration threshold …

f11bdd1

…for transactions. Update documentation and README to reflect new settings, including changes to transaction filtering criteria. Remove unused demo elements from example HTML for improved clarity.

Refactor performance monitoring code by adding missing commas for con…

c4f0094

…sistency and improving documentation clarity. Update comments to enhance understanding of methods and parameters.

Add retries

e5a32ca

Enhance performance monitoring by adding detailed documentation for S…

17c44f5

…pan and Transaction classes, including descriptions for properties and methods. Remove unused types from performance module and update imports for better clarity and organization.

Refactor consoleCatcher and performance monitoring code for improved …

61649a9

…readability. Adjust formatting for better alignment and clarity, and update import statements for consistency.

TatianaFomina requested a review from neSpecc March 16, 2025 20:07

neSpecc reviewed Mar 17, 2025

View reviewed changes

src/types/transaction.ts

/**

* Total number of transactions in this group

*/

count: number;

Copy link

Member

neSpecc Mar 17, 2025

Choose a reason for hiding this comment

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

move count under name

neSpecc reviewed Apr 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(perf): Add performance measuring api #117

feat(perf): Add performance measuring api #117

TatianaFomina commented Mar 15, 2025 •

edited

Loading

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Mar 17, 2025

neSpecc Apr 2, 2025

	public queueTransaction(transaction: Transaction): void {
	public enqueueTransaction(transaction: Transaction): void {


		this.sendRetries.set(tx.id, retryCount);

		const shouldRetry = retryCount <= MAX_SEND_RETRIES;

	private queueForSending(): void {
	private enqueueForSending(): void {

feat(perf): Add performance measuring api #117

Are you sure you want to change the base?

feat(perf): Add performance measuring api #117

Conversation

TatianaFomina commented Mar 15, 2025 • edited Loading

Performance Monitoring API

Features

API

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TatianaFomina commented Mar 15, 2025 •

edited

Loading