Skip to content

chore: capture performance of parsing api response #37081

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

Merged
vsvamsi1 merged 4 commits into from
Oct 25, 2024
Merged

chore: capture performance of parsing api response #37081

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ab2e1da
capture performance of parsing api response
vsvamsi1 Oct 25, 2024
c80224e
small fix
vsvamsi1 Oct 25, 2024
46887ac
samll fix
vsvamsi1 Oct 25, 2024
92f9d88
axios fix
vsvamsi1 Oct 25, 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
25 changes: 25 additions & 0 deletions app/client/src/api/Api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
} from "./interceptors";
import { REQUEST_TIMEOUT_MS } from "ee/constants/ApiConstants";
import { convertObjectToQueryParams } from "utils/URLUtils";
import { startAndEndSpanForFn } from "UITelemetry/generateTraces";

export const apiRequestConfig = {
baseURL: "/api/",
Expand All @@ -19,6 +20,30 @@ export const apiRequestConfig = {

const axiosInstance: AxiosInstance = axios.create();

axiosInstance.defaults.transformResponse = [
function (...args) {
const transformResponseAr = axios.defaults.transformResponse;

// Pick up the transformFn from axios defaults and wrap it in with telemetry code so that we can capture how long it takes parse an api response
if (Array.isArray(transformResponseAr) && transformResponseAr?.[0]) {
const transfromFn = transformResponseAr?.[0];
const resp = startAndEndSpanForFn(
"axios.transformApiResponse",
{ url: this.url },
() => transfromFn.call(this, ...args),
);

return resp;
} else {
// eslint-disable-next-line no-console
console.error("could not find the api transformerFn");

// return the data as it is.
return args[0];
}
},
];

axiosInstance.interceptors.request.use(apiRequestInterceptor);

axiosInstance.interceptors.response.use(
Expand Down