Skip to content

Commit

Permalink
fix typos (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgasquez authored Nov 7, 2024
1 parent 484fc27 commit 65d839f
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 20 deletions.
7 changes: 7 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
{
"name": "Development Container",
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm",
"customizations": {
"vscode": {
"extensions": [
"yzhang.markdown-all-in-one"
]
}
},
"postCreateCommand": "curl -L https://github.com/duckdb/duckdb/releases/download/v1.1.2/duckdb_cli-linux-amd64.zip -o duckdb.zip && unzip -o duckdb.zip && chmod +x duckdb && mkdir -p ~/.local/bin && mv -f duckdb ~/.local/bin/ && rm duckdb.zip"
}
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Status

At least of 2024-10-30, this dasbhoard is a scrappy work-in-progress to help spur discussion at [FDS-5 Bangkok](https://www.fildev.io/FDS-5) and shouldn't be viewed as canonical. It is being worked on actively by members of the "[PMF Targets Working Group](https://protocollabs.notion.site/Filecoin-PMF-Targets-Working-Group-111837df73d480b6a3a9e5bfd73063de?pvs=4)".
At least of 2024-10-30, this dashboard is a scrappy work-in-progress to help spur discussion at [FDS-5 Bangkok](https://www.fildev.io/FDS-5) and shouldn't be viewed as canonical. It is being worked on actively by members of the "[PMF Targets Working Group](https://protocollabs.notion.site/Filecoin-PMF-Targets-Working-Group-111837df73d480b6a3a9e5bfd73063de?pvs=4)".

## Purpose

The purpose of this dashboard currently is to help fascilitate the market between onramps/aggregators and Storage Providers (SPs) so onramps/aggregators can find SPs to use and SPs can understand how they are being evaluated. This is being done by by exposing SP performance against the service classes with their supporting SLOs as defined in [filecoin-project/service-classes](https://github.com/filecoin-project/service-classes).
The purpose of this dashboard currently is to help facilitate the market between onramps/aggregators and Storage Providers (SPs) so onramps/aggregators can find SPs to use and SPs can understand how they are being evaluated. This is being done by exposing SP performance against the service classes with their supporting SLOs as defined in [filecoin-project/service-classes](https://github.com/filecoin-project/service-classes).

## Dashboard URL

Expand All @@ -21,13 +21,13 @@ See [metrics.md](./src/metrics.md) and [faq.md](./src/faq.md)

If you want to help with data presentation, layout, etc. please see [implementation details](#implementation-details) below and open a PR.

Discussion and improvement proposals around service classes, SLOs, SLIs, and their defitions should occur in [filecoin-project/service-classes](https://github.com/filecoin-project/service-classes).
Discussion and improvement proposals around service classes, SLOs, SLIs, and their definitions should occur in [filecoin-project/service-classes](https://github.com/filecoin-project/service-classes).

## Development environment
Below are the expected tools to install:
* `npm` - Not needed if you're using [devcontainer.json](.devontainer/devcontainer.json)
* [DuckDB CLI](https://duckdb.org/docs/installation/) - Not needed if you're using [devcontainer.json](.devontainer/devcontainer.json)
* [Markdown All in One VS Code extension](https://markdown-all-in-one.github.io/) - This is used for markdown-all-in-one.github.io/docs/guide/table-of-contents.html, including its syntax for for ommitting certain headers.
* [Markdown All in One VS Code extension](https://markdown-all-in-one.github.io/docs/guide/#features) - This is used for generating [table of contents](https://markdown-all-in-one.github.io/docs/guide/table-of-contents.html), including its syntax for omitting certain headers.

## Implementation Details

Expand Down Expand Up @@ -61,11 +61,11 @@ For more, see <https://observablehq.com/framework/getting-started>.

## Command reference

| Command | Description |
| ----------------- | -------------------------------------------------------- |
| `npm install` | Install or reinstall dependencies |
| `npm run dev` | Start local preview server |
| `npm run build` | Build your static site, generating `./dist` |
| `npm run deploy` | Deploy your app to Observable |
| `npm run clean` | Clear the local data loader cache |
| `npm run observable` | Run commands like `observable help` |
| Command | Description |
| -------------------- | ------------------------------------------- |
| `npm install` | Install or reinstall dependencies |
| `npm run dev` | Start local preview server |
| `npm run build` | Build your static site, generating `./dist` |
| `npm run deploy` | Deploy your app to Observable |
| `npm run clean` | Clear the local data loader cache |
| `npm run observable` | Run commands like `observable help` |
2 changes: 1 addition & 1 deletion src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Status

This dasbhoard is a scrappy work-in-progress to help spur discussion at [FDS-5 Bangkok](https://www.fildev.io/FDS-5) and shouldn't be viewed as canonical. It is being worked on actively by members of the "[PMF Targets Working Group](https://protocollabs.notion.site/Filecoin-PMF-Targets-Working-Group-111837df73d480b6a3a9e5bfd73063de?pvs=4)".
This dashboard is a scrappy work-in-progress to help spur discussion at [FDS-5 Bangkok](https://www.fildev.io/FDS-5) and shouldn't be viewed as canonical. It is being worked on actively by members of the "[PMF Targets Working Group](https://protocollabs.notion.site/Filecoin-PMF-Targets-Working-Group-111837df73d480b6a3a9e5bfd73063de?pvs=4)".

```js
const daily_metrics = FileAttachment("data/daily_metrics.csv").csv({typed: true});
Expand Down
14 changes: 7 additions & 7 deletions src/metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Metric Definitions <!-- omit from toc -->

Below are explanatory notes on the metrics that that are visualized on this dasbhoard. One can always check the [dashboard source code](https://github.com/filecoin-project/filecoin-storage-providers-market) to confirm accuracy.
Below are explanatory notes on the metrics that that are visualized on this dashboard. One can always check the [dashboard source code](https://github.com/filecoin-project/filecoin-storage-providers-market) to confirm accuracy.

- [Abbreviations](#abbreviations)
- [Aggregate Metrics](#aggregate-metrics)
Expand All @@ -24,34 +24,34 @@ The following abbreviations are used throughout this page and site:
* SP - storage provider. And by "storage provider", we mean the entity as defined in the Filecoin protocol with an individual id that commits sectors, accepts deals, etc.

## Aggregate Metrics
These are metrics looking across all stroage providers in the network. They correspond with the aggregate views displayed at the [dashboard home](/).
These are metrics looking across all storage providers in the network. They correspond with the aggregate views displayed at the [dashboard home](/).

### Providers Making State Market Deals
This looks at the number of providers who made a state market deal on a given day. This gives a sense of the number of "active storage providers".

### Providers With Active State Market Deals
On a given day, how many storage providers have a active state market deals. This is gives a sense of the number of "active storage providers".
On a given day, how many storage providers have a active state market deals. This gives a sense of the number of "active storage providers".

### "Warm" Service Class Conformance
This shows the number of Storage Providers in a given day that met the ["warm" service class service level objectives](https://github.com/filecoin-project/service-classes/service-classes/warm.md). If a given SP only meets some of the SLOs, these are highlighted as well.

### "Cold" Service Class Conformance
This shows the number of Storage Providers in a given day that met the ["cold" service class service level objectives](https://github.com/filecoin-project/service-classes/service-classes/cold.md). If a given SP only meets some of the SLOs, these are highlighted as well.
This shows the number of Storage Providers in a given day that met the ["cold" service class service level objectives](https://github.com/filecoin-project/service-classes/service-classes/cold.md). If a given SP only meets some of the SLOs, these are highlighted as well.

## Individual Storage Provider Metrics
These are metrics that specific to an individual SP at `/provider/providerId`.

### Spark Retrieval Success Rate
This shows a Storage Provider's [Spark Retrieval Success Rate](https://github.com/filecoin-project/service-classes/service-level-indicators/spark-retrieval-success-rate.md). The horizontal line's value, which corresponds with a service level objective, is defined in the supporting [service class definition](https://github.com/filecoin-project/service-classes/service-classes) (e.g., ["warm"](https://github.com/filecoin-project/service-classes/service-classes/warm.md)).
This shows a Storage Provider's [Spark Retrieval Success Rate](https://github.com/filecoin-project/service-classes/service-level-indicators/spark-retrieval-success-rate.md). The horizontal line's value, which corresponds with a service level objective, is defined in the supporting [service class definition](https://github.com/filecoin-project/service-classes/service-classes) (e.g; ["warm"](https://github.com/filecoin-project/service-classes/service-classes/warm.md)).

### Spark Retrieval Requests
This shows the number of Spark Retrievel Requests that were made and accepted each day. This is the denominator of the [Spark Retrieval Success Rate](#spark-retrieval-success-rate). It is showed so one can get a sense of how much retrieval checking was done for an SP for a given day. Note that this doesn't show the number of unique CIDs an SP had checked, but rather the total number of checks.
This shows the number of Spark Retrieval Requests that were made and accepted each day. This is the denominator of the [Spark Retrieval Success Rate](#spark-retrieval-success-rate). It is showed so one can get a sense of how much retrieval checking was done for an SP for a given day. Note that this doesn't show the number of unique CIDs an SP had checked, but rather the total number of checks.

### State Market Deals Data Onboarding
The amount of data onboarded by an SP for a given day via the State Market actor.

### State Market Deals
The number of deals in a day that were made by an SP via the State Market actor",
The number of deals in a day that were made by an SP via the State Market actor.

### Raw Power
The amount of raw power an SP had when sampled each day.
Expand Down

0 comments on commit 65d839f

Please sign in to comment.