32 lines
3.3 KiB
Markdown
32 lines
3.3 KiB
Markdown
# `Profiling` [class-Profiling]
|
|
|
|
## Constructor
|
|
|
|
```typescript
|
|
new Profiling(transport: [Transport](./Transport.md));
|
|
```
|
|
|
|
## Properties [class-properties-Profiling]
|
|
|
|
| Name | Type | Description |
|
|
| - | - | - |
|
|
| `acceptedParams` | Record<string, { path: string[]; body: string[]; query: string[]; }> | |
|
|
| `transport` | [Transport](./Transport.md) | |
|
|
|
|
## Methods [class-methods-Profiling]
|
|
|
|
| Name | Signature | Description |
|
|
| - | - | - |
|
|
| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. |
|
|
| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | |
|
|
| `flamegraph` | `flamegraph(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | |
|
|
| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts raw stacktrace information from Universal Profiling. |
|
|
| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | |
|
|
| `stacktraces` | `stacktraces(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | |
|
|
| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Returns basic information about the status of Universal Profiling. |
|
|
| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | |
|
|
| `status` | `status(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | |
|
|
| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[TODO](./TODO.md)>;` | Extracts a list of topN functions from Universal Profiling. |
|
|
| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[TODO](./TODO.md), unknown>>;` | |
|
|
| `topnFunctions` | `topnFunctions(this: [That](./That.md), params?: [TODO](./TODO.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[TODO](./TODO.md)>;` | |
|