Skip to content
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.

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

docs: update screens #24

Merged
merged 1 commit into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<PropertyGroup>
<VersionPrefix>0.7.0</VersionPrefix>
<VersionPrefix>0.8.0</VersionPrefix>
<RepositoryUrl>https://github.com/Ne4to/Heartbeat</RepositoryUrl>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Heartbeat
[![NuGet Badge](https://buildstats.info/nuget/heartbeat?includePreReleases=true&dWidth=0)](https://www.nuget.org/packages/Heartbeat/)
[![NuGet Badge](https://buildstats.info/nuget/heartbeat?includePreReleases=false&dWidth=0)](https://www.nuget.org/packages/Heartbeat/)

Diagnostics utility with web UI to analyze .NET application memory dump

Expand Down Expand Up @@ -66,7 +66,9 @@ Options:
-?, -h, --help Show help and usage information
```

See [UI screen](https://github.com/Ne4to/Heartbeat/tree/master/assets) for examples.
### Features
<!-- do not change to relative path, file included in NuGet readme it works only with absolute path -->
See [Features](https://github.com/Ne4to/Heartbeat/blob/master/docs/features.md) for more info.

### Listening endpoint

Expand Down
Binary file removed assets/01-dashboard.jpeg
Binary file not shown.
Binary file removed assets/02-heap-dump.jpeg
Binary file not shown.
Binary file removed assets/03-segments.jpeg
Binary file not shown.
Binary file removed assets/04-roots.jpeg
Binary file not shown.
Binary file removed assets/05-modules.jpeg
Binary file not shown.
Binary file removed assets/06-strings.jpeg
Binary file not shown.
Binary file removed assets/07-string-duplicates.jpeg
Binary file not shown.
Binary file removed assets/08-single-objest.jpeg
Binary file not shown.
Binary file removed assets/09-object-list.jpeg
Binary file not shown.
9 changes: 0 additions & 9 deletions assets/README.md

This file was deleted.

Binary file added docs/assets/01-dashboard.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/02-heap-dump.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/02.1-object-fields.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/02.2-object-root.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/02.3-object-array-items.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/02.4-object-dictionary-items.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/02.5-object-as-jwt.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/03-segments.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/04-roots.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/05-modules.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/06-sparse-arrays.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/07-arrays.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/08-http-requests.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/09-strings.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/10-string-duplicates.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
61 changes: 61 additions & 0 deletions docs/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
- [Basic dump information](#basic-dump-information)
- [Heap Dump](#heap-dump)
- [Object fields](#object-fields)
- [Object GC root path](#object-gc-root-path)
- [Array items](#array-items)
- [Dictionary items](#dictionary-items)
- [Decode JSON Web Token (JWT)](#decode-json-web-token-jwt)
- [Heap segments](#heap-segments)
- [Heap roots](#heap-roots)
- [Modules](#modules)
- [Sparse arrays summary](#sparse-arrays-summary)
- [Arrays](#arrays)
- [HTTP requests](#http-requests)
- [Strings](#strings)
- [String duplicates](#string-duplicates)

### Basic dump information
<a href="./assets/01-dashboard.jpeg"><img src="./assets/01-dashboard.jpeg" alt="Dashboard" width="60%"/><a>

### Heap Dump
<a href="./assets/02-heap-dump.jpeg"><img src="./assets/02-heap-dump.jpeg" alt="Heap dump" width="60%"/><a>

#### Object fields
<a href="./assets/02.1-object-fields.jpeg"><img src="./assets/02.1-object-fields.jpeg" alt="Object fields" width="60%"/><a>

#### Object GC root path
<a href="./assets/02.2-object-root.jpeg"><img src="./assets/02.2-object-root.jpeg" alt="Object GC root path" width="60%"/><a>

#### Array items
<a href="./assets/02.3-object-array-items.jpeg"><img src="./assets/02.3-object-array-items.jpeg" alt="Array items" width="60%"/><a>

#### Dictionary items
<a href="./assets/02.4-object-dictionary-items.jpeg"><img src="./assets/02.4-object-dictionary-items.jpeg" alt="Dictionary items" width="60%"/><a>

#### Decode JSON Web Token (JWT)
<a href="./assets/02.5-object-as-jwt.jpeg"><img src="./assets/02.5-object-as-jwt.jpeg" alt="JWT" width="60%"/><a>

### Heap segments
<a href="./assets/03-segments.jpeg"><img src="./assets/03-segments.jpeg" alt="Segments" width="60%"/><a>

### Heap roots
<a href="./assets/04-roots.jpeg"><img src="./assets/04-roots.jpeg" alt="Roots" width="60%"/><a>

### Modules
<a href="./assets/05-modules.jpeg"><img src="./assets/05-modules.jpeg" alt="Modules" width="60%"/><a>

### Sparse arrays summary
<a href="./assets/06-sparse-arrays.jpeg"><img src="./assets/06-sparse-arrays.jpeg" alt="Sparse arrays summary" width="60%"/><a>

### Arrays
<a href="./assets/07-arrays.jpeg"><img src="./assets/07-arrays.jpeg" alt="Arrays" width="60%"/><a>

### HTTP requests
<a href="./assets/08-http-requests.jpeg"><img src="./assets/08-http-requests.jpeg" alt="HTTP requests" width="60%"/><a>

### Strings
<a href="./assets/09-strings.jpeg"><img src="./assets/09-strings.jpeg" alt="Strings" width="60%"/><a>

### String duplicates
<a href="./assets/10-string-duplicates.jpeg"><img src="./assets/10-string-duplicates.jpeg" alt="String duplicates" width="60%"/><a>

2 changes: 1 addition & 1 deletion src/Heartbeat/ClientApp/src/pages/arraysGrid/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Icon from '@mui/icons-material/ViewModule';
import Icon from '@mui/icons-material/ViewArray';
import { ArraysGrid } from './ArraysGrid';

export default {
Expand Down
1 change: 1 addition & 0 deletions src/Heartbeat/ClientApp/src/pages/clrObject/ClrObject.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {ClrObjectRoot} from "../../components/ClrObjectRoot";
import {ProgressContainer} from "../../components/ProgressContainer";
import Box from "@mui/material/Box";

// TODO add refs to current object
// TODO add Dictionary, Queue, Stack and other collections view to a new tab
// TODO add ConcurrentDictionary view to a new tab (dcd, dumpconcurrentdictionary <address> Displays concurrent dictionary content.)
// TODO add ConcurrentQueue view to a new tab (dcq, dumpconcurrentqueue <address> Displays concurrent queue content.)
Expand Down
2 changes: 1 addition & 1 deletion src/Heartbeat/ClientApp/src/pages/httpRequests/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Icon from '@mui/icons-material/ViewModule';
import Icon from '@mui/icons-material/Http';
import { HttpRequests } from './HttpRequests';

export default {
Expand Down
2 changes: 1 addition & 1 deletion src/Heartbeat/ClientApp/src/pages/roots/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Icon from '@mui/icons-material/ViewModule';
import Icon from '@mui/icons-material/AccountTree';
import { RootsGrid } from './RootsGrid';

export default {
Expand Down
2 changes: 1 addition & 1 deletion src/Heartbeat/ClientApp/src/pages/segments/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Icon from '@mui/icons-material/Comment';
import Icon from '@mui/icons-material/LowPriority';
import { SegmentsGrid } from './SegmentsGrid';

export default {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Icon from '@mui/icons-material/ViewModule';
import Icon from '@mui/icons-material/DataArray';
import { SparseArraysStat } from './SparseArraysStat';

export default {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Icon from '@mui/icons-material/ViewModule';
import Icon from '@mui/icons-material/Layers';
import { StringDuplicates } from './StringDuplicates';

export default {
Expand Down
2 changes: 1 addition & 1 deletion src/Heartbeat/ClientApp/src/pages/stringsGrid/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Icon from '@mui/icons-material/ViewModule';
import Icon from '@mui/icons-material/Gesture';
import { StringsGrid } from './StringsGrid';

export default {
Expand Down
Loading