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

chore: update diagnostic-tools.md #1934

Merged
merged 2 commits into from
Oct 2, 2024
Merged
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
13 changes: 4 additions & 9 deletions docs/reference/diagnostic-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,19 @@ Here are several tools you can use to investigate and diagnose common issues wit

## IPLD Explorer

[IPLD Explorer](https://explore.ipld.io/) allows you to visualize and explore the IPLD DAG representing a given CID or CAR file. The tool provides the following featured datasets to explore:

- [Project Apollo archives](https://explore.ipld.io/#/explore/QmSnuWmxptJZdLJpKRarxBMS2Ju2oANVrgbr2xWbie9b2D)
- [IGIS Git repository](https://explore.ipld.io/#/explore/baf4bcfg4ep767tjp5lxyanx5urpjjgx5q2volvy)
- [An Ethereum block](https://explore.ipld.io/#/explore/bagiacgzah24drzou2jlkixpblbgbg6nxfrasoklzttzoht5hixhxz3rlncyq)
- [XKCD archives](https://explore.ipld.io/#/explore/QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm)
Comment on lines -14 to -17
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example list changed, and some of these no longer work. Main landing page lists up-to-date examples, so removing them from here, saving screen estate.

[IPLD Explorer](https://explore.ipld.io/) allows you to visualize and explore the [IPLD](../concepts/glossary.md#ipld) [DAG](../concepts/glossary.md#dag) representing a given [CID](../concepts/glossary.md#cid) or [CAR](../concepts/glossary.md#car) file.

## IPFS check

[IPFS Check](https://check.ipfs.network/) helps determine the retrievability of a CID from IPFS Mainnet, either from a specific peer given a multiaddress, or from multiple providers.
[IPFS Check](https://check.ipfs.network/) helps determine the retrievability of a CID from IPFS [Mainnet](../concepts/glossary.md#mainnet), either from a specific [peer](../concepts/glossary.md#peer) given a [multiaddress](../concepts/glossary.md#multiaddr), or from multiple providers.

@[youtube](XeNOQDOrdC0)

Each error type output by the tool can indicate a solution to your problem:

- **Could not connect to the multiaddr** indicates that machines on the internet cannot talk to your machine. Fix your firewall, add port forwarding, or use a relay.
- **Could not find address in the DHT** indicates that your machine is either not connected to the Amino DHT (even as a client), or it is not advertising the address that you are using to test.
- **Multihash not advertised in the DHT** indicates that your machine has not advertised that it has the requested content in the Amino DHT. If you're using Kubo, enable the [Accelerated DHT Client](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#accelerated-dht-client).
- **Could not find address in the DHT** indicates that your machine is either not connected to the [Amino](../concepts/glossary.md#amino) DHT (even as a client), or it is not advertising the address that you are using to test.
- **Multihash not advertised in the DHT** indicates that your machine has not advertised that it has the requested content in the Amino DHT.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rationale: we know there could be other reasons, such as people just unknowingly disabling announcements via lowpower profile (ipfs/kubo#10524).

Let's remove this kubo-specific suggestion, as it may do more harm than good (we know that it makes Kubo-based gateway perform worse with accelerated client enabled (notes))

- **Peer has not responded that it has the CID** indicates that your node cannot find the block that you believe it has, or that there may be some other sort of network latency.

## CID inspector
Expand Down