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.

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

Jump to bottom

Documentation updating #1052

Merged
merged 30 commits into from
Feb 23, 2022
Merged

Documentation updating #1052

merged 30 commits into from
Feb 23, 2022

Conversation

AmberKiso
Copy link
Contributor

@AmberKiso AmberKiso commented Feb 20, 2022 •
edited
Loading

Summary

Update documentation for a few outstanding bugs
Fix #863
Fix #864
Fix #906

Testing Plan

Looked at the .md files on Github's rich diff.

Breaking Change

Is this a breaking change? If yes, add notes below on why this is breaking and
what additional work is required, if any.

[ ] Yes
[X] No

NullSoldier and others added 8 commits February 16, 2022 16:18
@NullSoldier @dguenther
@mat-if @wd021 @rohanjadvani
STAGING -> MASTER (iron-fish#1031)
0e9e22f 
* Update to latest napi-rs to fix BigInt usage (iron-fish#1014)

* Update RpcClient routes to use ApiNamespace enum (iron-fish#1013)

Minor change to RpcClient to utilize the ApiNamespace enum for route definition. Since we have a non-stringly-typed enum already, using it here just minimizes the risk of a typo that breaks a route.

* Move telemetry tags to fields (iron-fish#1026)

We are doing this to reduce cardinality. Indexes are created from the
combination of measurement and tags. This means every node session ends
up getting it's own indexes which blows out our cardinality and causes
causes InfluxDB to stop processing data. You can read more about this
issue here:

https://docs.influxdata.com/influxdb/cloud/write-data/best-practices/resolve-high-cardinalityg

* Fix ordering issue in creating telemetry node id (iron-fish#1027)

The issue is that Node.Init() happens before the telemetry node id is
created for the first time. We simply move that up, and configure it on
the SDK itself which gets passed to the constructed node.

* fix miners:mined scanning status (iron-fish#994)

* Return a Buffer instead of a NativeNote from decryption functions (iron-fish#1025)

* feat(ironfish): Move metrics monitor inside telemetry (iron-fish#1029)

* feat(ironfish): Submit peer metrics in telemetry  (iron-fish#1030)

* feat(ironfish): Move metrics monitor inside telemetry

* feat(ironfish): Submit peer metrics in telemetry

* Bump version to 0.1.23 (iron-fish#1028)

Co-authored-by: Derek Guenther <dguenther9@gmail.com>
Co-authored-by: mat-if <97762857+mat-if@users.noreply.github.com>
Co-authored-by: wd021 <dannywitters@gmail.com>
Co-authored-by: Rohan Jadvani <5459049+rohanjadvani@users.noreply.github.com>
@rohanjadvani
Merge pull request iron-fish#1046 from iron-fish/staging
1f3dc31 
`staging` -> `master`
@AmberKiso
Doc update 1
83a48c3 
Remove test:slow
Add referencing bugs fixed in the PR description.
@AmberKiso
Update graph explorer readme.md
8b4ce3d
@AmberKiso
Update locations of where test: commands can be run
cedac9b
@AmberKiso
Add request to add bugs being fixed to PRs
78fee3c
@AmberKiso
Update graph explorer readme
95922f8
@AmberKiso
Update CONTRIBUTING.md
1a634a0
@AmberKiso AmberKiso marked this pull request as ready for review February 20, 2022 18:50
@AmberKiso AmberKiso requested a review from a team as a code owner February 20, 2022 18:50
NullSoldier
NullSoldier reviewed Feb 22, 2022
View reviewed changes
README.md Show resolved Hide resolved
@NullSoldier NullSoldier changed the base branch from master to staging February 22, 2022 21:19
@NullSoldier
Copy link
Contributor

NullSoldier commented Feb 22, 2022 •
edited
Loading

I just retargeted this to staging, can you rebase this on staging? We try not to merge things into master. You can use git pull -r origin staging

NullSoldier and others added 16 commits February 22, 2022 19:59
@NullSoldier @AmberKiso
Bump ironfish-cli to 0.1.22
af820af
@dguenther @AmberKiso
Update to latest napi-rs to fix BigInt usage (iron-fish#1014)
3eab6b8
@mat-if @AmberKiso
Update RpcClient routes to use ApiNamespace enum (iron-fish#1013)
3937cdd 
Minor change to RpcClient to utilize the ApiNamespace enum for route definition. Since we have a non-stringly-typed enum already, using it here just minimizes the risk of a typo that breaks a route.
@NullSoldier @AmberKiso
Move telemetry tags to fields (iron-fish#1026)
cfcb5ae 
We are doing this to reduce cardinality. Indexes are created from the
combination of measurement and tags. This means every node session ends
up getting it's own indexes which blows out our cardinality and causes
causes InfluxDB to stop processing data. You can read more about this
issue here:

https://docs.influxdata.com/influxdb/cloud/write-data/best-practices/resolve-high-cardinalityg
@NullSoldier @AmberKiso
Fix ordering issue in creating telemetry node id (iron-fish#1027)
f6beff8 
The issue is that Node.Init() happens before the telemetry node id is
created for the first time. We simply move that up, and configure it on
the SDK itself which gets passed to the constructed node.
@wd021 @AmberKiso
fix miners:mined scanning status (iron-fish#994)
e72e0b8
@dguenther @AmberKiso
Return a Buffer instead of a NativeNote from decryption functions (ir…
1640392 
…on-fish#1025)
@rohanjadvani @AmberKiso
feat(ironfish): Move metrics monitor inside telemetry (iron-fish#1029)
6c4b49f
@rohanjadvani @AmberKiso
feat(ironfish): Submit peer metrics in telemetry (iron-fish#1030)
1dbde81 
* feat(ironfish): Move metrics monitor inside telemetry

* feat(ironfish): Submit peer metrics in telemetry
@rohanjadvani @AmberKiso
Bump version to 0.1.23 (iron-fish#1028)
7005924
@mat-if @AmberKiso
Add telemetry status to status command (iron-fish#1036)
8ae3a5e
@rohanjadvani @AmberKiso
feat(ironfish): Update telemetry flush and metrics intervals to 5m (i…
67289f0 
…ron-fish#1038)

* feat(ironfish): Update telemetry flush interval from 5s to 60s

* Update to 5m

* Update METRICS_INTERVAL
@rohanjadvani @AmberKiso
fix(ironfish): Pass in metrics and remove peer network from telemetry (…
84a239a 
…iron-fish#1033)

* fix(ironfish): Pass in metrics and remove peer network from telemetry

* s/peersCount/p2p_PeersCount
@NullSoldier @AmberKiso
Change getStatus() RPC to use new metrics gauge (iron-fish#1045)
15b3eaf
@rohanjadvani @AmberKiso
v0.1.24 (iron-fish#1044)
3175efb
@AmberKiso
Doc update 1
af48234 
Remove test:slow
Add referencing bugs fixed in the PR description.
@AmberKiso
Copy link
Contributor Author

AmberKiso commented Feb 23, 2022 •
edited
Loading

@NullSoldier Ran the command line, then pushed origin.

For my current PRs, they all started with me branching from master. For future PR, should I branch from upstream\staging?
(GIthub desktop shows that branch as 4 days old versus a 1 month old staging.)

@dguenther
Copy link
Member

Yep, I think basing on upstream/staging should be right. It'll depend what the name of git remote corresponding to the ironfish repository is when you run git remote -v, but that's more than likely upstream.

@dguenther dguenther merged commit 80bfd4c into iron-fish:staging Feb 23, 2022
This was referenced Feb 24, 2022
Closed
Closed
Closed
@AmberKiso AmberKiso deleted the more-documentation-fixing branch February 24, 2022 01:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NullSoldier NullSoldier NullSoldier approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
6 participants
@AmberKiso @NullSoldier @dguenther @rohanjadvani @mat-if @wd021