This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 833
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6773 from matrix-org/travis/rl/perf-metrics
[Release] Add config option to turn on in-room event sending timing metrics
- Loading branch information
Showing
4 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
/* | ||
Copyright 2021 The Matrix.org Foundation C.I.C. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
import { MatrixClient } from "matrix-js-sdk/src"; | ||
|
||
/** | ||
* Decorates the given event content object with the "send start time". The | ||
* object will be modified in-place. | ||
* @param {object} content The event content. | ||
*/ | ||
export function decorateStartSendingTime(content: object) { | ||
content['io.element.performance_metrics'] = { | ||
sendStartTs: Date.now(), | ||
}; | ||
} | ||
|
||
/** | ||
* Called when an event decorated with `decorateStartSendingTime()` has been sent | ||
* by the server (the client now knows the event ID). | ||
* @param {MatrixClient} client The client to send as. | ||
* @param {string} inRoomId The room ID where the original event was sent. | ||
* @param {string} forEventId The event ID for the decorated event. | ||
*/ | ||
export function sendRoundTripMetric(client: MatrixClient, inRoomId: string, forEventId: string) { | ||
// noinspection JSIgnoredPromiseFromCall | ||
client.sendEvent(inRoomId, 'io.element.performance_metric', { | ||
"io.element.performance_metrics": { | ||
forEventId: forEventId, | ||
responseTs: Date.now(), | ||
kind: 'send_time', | ||
}, | ||
}); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters