fix: stream health remove (#588)

0xcadams · web-flow · commit 35afafc9e8ba · 2024-06-12T13:04:53.000-07:00
* fix: stream health remove

* fix: move to info
diff --git a/developers/guides/monitor-stream-health.mdx b/developers/guides/monitor-stream-health.mdx
@@ -258,7 +258,7 @@ may suggest that your encoder is misconfigured or that the streamer internet
 connection isn't as strong as it should be to deliver high-quality streams to
 your viewers.
 
-## Monitoring Stream Health Using The Dashboard
+### Monitoring in the Dashboard
 
 In the dashboard, there will be a `health` tab on the right side:
 
@@ -283,336 +283,9 @@ At the bottom of the page, a chart will show the ingest rate of a livestream:
   ![image](https://user-images.githubusercontent.com/79172645/135467197-08ec63ab-4c44-4cad-a0d5-95a76b80e5c5.png)
 </Frame>
 
-## Monitor Stream Health Using The API
+### Monitor with the API
 
-The health information about a stream can also be queried using a separate
-Stream Health API resides on a different root path `/data`. To use it, you need
-to include the same API key as the one used for the regular API. The API
-consists of the following endpoints:
-
-- Health Status (`/data/stream/{streamId}/health`): Grabs the latest health
-  status info about a given stream, referenced by its Stream ID. This API powers
-  the dashboard health checks and multistream status.
-- Events (`/data/stream/{streamId}/events`): Provides direct access to the
-  low-level events sent by Livepeer video-processing services. It also allows
-  subscribing via SSE to receive new events and is useful for debugging. This
-  API powers the log feed in the dashboard.
-
-Now let's go into more detail about each of the mentioned API endpoints.
-
-## Health Status
-
-The stream ID is the same one as used in the Livestream API.
-
-`GET livepeer.studio/data/stream/{id}/health`
-
-<Tabs>
-  <Tab title="Node.js">
-    ```javascript
-    import { Livepeer } from "livepeer";
-
-    const apiKey = 'YOUR_API_KEY';
-    const streamId = 'STREAM_ID';
-
-    const livepeer = new Livepeer({apiKey});
-
-    livepeer
-      .getStreamHealth(streamId)
-      .then((response) => {
-        console.log("Stream health:", response);
-      })
-      .catch((error) => {
-        console.error("Error fetching stream health:", error);
-      });
-    ```
-
-  </Tab>
-
-  <Tab title="Python">
-    ```python
-    from livepeer import Livepeer
-
-    # Initialize the Livepeer client with your API key
-    api_key = "YOUR_API_KEY"
-    livepeer = Livepeer(api_key)
-
-    # Define the stream ID for which you want to check health
-    stream_id = "STREAM_ID"
-
-    try:
-        # Get stream health by stream ID
-        response = livepeer.get_stream_health(stream_id)
-        print("Stream health:", response)
-    except Exception as e:
-        print("Error fetching stream health:", e)
-    ```
-
-  </Tab>
-
-  <Tab title="Go">
-    ```go
-    package main
-
-    import (
-      "fmt"
-      "os"
-
-      "github.com/livepeer/livepeer-go"
-    )
-
-    func main() {
-      // Initialize the Livepeer client with your API key
-      apiKey := "YOUR_API_KEY"
-      client := livepeer.NewLivepeerClient(apiKey)
-
-      // Define the stream ID for which you want to check health
-      streamID := "STREAM_ID"
-
-      // Get stream health by stream ID
-      response, err := client.GetStreamHealth(streamID)
-      if err != nil {
-        fmt.Printf("Error fetching stream health: %v\n", err)
-        os.Exit(1)
-      }
-
-      fmt.Printf("Stream health: %+v\n", response)
-    }
-    ```
-
-  </Tab>
-</Tabs>
-
-### Response
-
-Returns an object with a `200 OK` response
-
-```json
-{
-  "id": "{id}",
-  "healthy": {
-    "status": true,
-    "frequency": { "1m": 1, "10m": 0.9655, "60m": 0.9655 },
-    "lastProbeTime": 1635993921603,
-    "lastTransitionsTime": 1635993751824
-  },
-  "conditions": [
-    {
-      "type": "Active",
-      "status": true,
-      "extraData": {
-        "nodeId": "prod-mist-blue-server-1",
-        "region": "lon"
-      },
-      "frequency": { "1m": 1, "10m": 1, "60m": 1 },
-      "lastProbeTime": 1635993739354,
-      "lastTransitionsTime": 1635993739354
-    },
-    {
-      "type": "Transcoding",
-      "status": true,
-      "frequency": { "1m": 1, "10m": 1, "60m": 1 },
-      "lastProbeTime": 1635993920641,
-      "lastTransitionsTime": 1635993751824
-    },
-    {
-      "type": "TranscodeRealTime",
-      "status": true,
-      "frequency": { "1m": 1, "10m": 1, "60m": 1 },
-      "lastProbeTime": 1635993920641,
-      "lastTransitionsTime": 1635993751824
-    },
-    {
-      "type": "TranscodeNoErrors",
-      "status": true,
-      "frequency": { "1m": 1, "10m": 1, "60m": 1 },
-      "lastProbeTime": 1635993920641,
-      "lastTransitionsTime": 1635993751824
-    },
-    {
-      "type": "Multistreaming",
-      "status": null,
-      "lastProbeTime": null,
-      "lastTransitionsTime": null
-    }
-  ],
-  "metrics": {
-    "MediaTimeMillis": [
-      {
-        "name": "MediaTimeMillis",
-        "dimensions": { "nodeId": "prod-mist-blue-server-1" },
-        "last": [1635993921603, 182528]
-      }
-    ],
-    "TranscodeRealtimeRatio": [
-      {
-        "name": "TranscodeRealtimeRatio",
-        "dimensions": {
-          "nodeId": "prod-livepeer-broadcaster-6emu-97d8bf496-7zh9f"
-        },
-        "last": [1635993920641, 3.088169642857143]
-      }
-    ]
-  }
-}
-```
-
-In the above response payload:
-
-- All `timestamps` are represented in milliseconds since the Unix epoch, which
-  is the default representation of timestamps across all the Livepeer API.
-- The `healthy` top-level `condition` is a computed state based on some specific
-  stream conditions. As of writing this doc, a stream is `healthy` if it's both
-  `Active`, `Transcoding` in realtime (`TranscodeRealTime`), and if multistream
-  targets are configured, they are also healthy (`Multistreaming`).
-- The `conditions` array contains more specific information about the stream
-  health state, with the `type` field specifying what the condition means.
-- More generally, a `Condition` represents a specific state of the stream
-  health.
-  - The `status` field represents the value of the last reading for that
-    condition, and the `lastProbeTime` specified when that was.
-  - The `lastTransitionsTime` and the `frequency` fields provide some insight
-    into how it's changing over time.
-  - The `lastTransitionTime` is the timestamp of the last time where the
-    condition status changed, and;
-  - The `frequency` is the ratio of successful probes (`status: true`) in the
-    specified time ranges preceding `lastProbeTime`.
-- The `metrics` are still an experimental API and are not recommended for
-  production systems. But the `last` field is a tuple containing the `timestamp`
-  and the `value` of the last reading for that metric.
-
-## Events
-
-### Request
-
-The stream ID is the same one used in the Livestream API.
-
-`GET livepeer.studio/data/stream/{id}/events`
-
-<Tabs>
-  <Tab title="Node.js">
-    ```javascript
-    import { Livepeer } from "livepeer";
-
-    const apiKey = 'YOUR_API_KEY';
-    const streamId = 'STREAM_ID';
-
-    const livepeer = new Livepeer({apiKey});
-
-    livepeer
-      .getStreamEvents(streamId)
-      .then((response) => {
-        console.log("Stream events:", response);
-      })
-      .catch((error) => {
-        console.error("Error fetching stream events:", error);
-      });
-    ```
-
-  </Tab>
-
-  <Tab title="Python">
-    ```python
-    from livepeer import Livepeer
-
-    # Initialize the Livepeer client with your API key
-    api_key = "YOUR_API_KEY"
-    livepeer = Livepeer(api_key)
-
-    # Define the stream ID for which you want to fetch events
-    stream_id = "STREAM_ID"
-
-    try:
-        # Get stream events by stream ID
-        response = livepeer.get_stream_events(stream_id)
-        print("Stream events:", response)
-    except Exception as e:
-        print("Error fetching stream events:", e)
-    ```
-
-  </Tab>
-
-  <Tab title="Go">
-    ```go
-    package main
-
-    import (
-      "fmt"
-      "os"
-
-      "github.com/livepeer/livepeer-go"
-    )
-
-    func main() {
-      // Initialize the Livepeer client with your API key
-      apiKey := "YOUR_API_KEY"
-      client := livepeer.NewLivepeerClient(apiKey)
-
-      // Define the stream ID for which you want to fetch events
-      streamID := "STREAM_ID"
-
-      // Get stream events by stream ID
-      response, err := client.GetStreamEvents(streamID)
-      if err != nil {
-        fmt.Printf("Error fetching stream events: %v\n", err)
-        os.Exit(1)
-      }
-
-      fmt.Printf("Stream events: %+v\n", response)
-    }
-    ```
-
-  </Tab>
-</Tabs>
-
-### Response
-
-Returns an object with a `200 OK` response
-
-```
-retry: 10000
-
-id: b6e0d6a4-0718-4db4-b2ec-31bb23a9fde0
-event: lp_event
-data: {"type":"media_server_metrics","id":"b6e0d6a4-0718-4db4-b2ec-31bb23a9fde0","timestamp":1635994871604,"streamId":"{id}","nodeId":"prod-mist-blue-server-1","region":"lon","stats":{"mediaTimeMs":1132566},"multistream":[]}
-
-id: 7a0e6f9e-baa1-42c4-a92f-4dfa2f50ac05
-event: lp_event
-data: {"type":"transcode","id":"7a0e6f9e-baa1-42c4-a92f-4dfa2f50ac05","timestamp":1635994875678,"streamId":"{id}","nodeId":"prod-livepeer-broadcaster-6emu-97d8bf496-7zh9f","segment":{"name":"","seqNo":292,"duration":8.334,"byteSize":2270100},"startTime":1635994874469,"latencyMs":1209,"success":true,"attempts":[{"orchestrator":{"address":"0x1cd98ad89a7d143847f62d2249e4005d09e10648","transcodeUri":"https://vno2-prod-livepeer-orchestrator-7.livepeer.studio:443"},"latencyMs":1209,"error":null}]}
-
-id: fd782a49-4986-4b3c-b3b4-9088ae76c152
-event: lp_event
-data:
-{"type":"media_server_metrics","id":"fd782a49-4986-4b3c-b3b4-9088ae76c152","timestamp":1635994881604,"streamId":"{id}","nodeId":"prod-mist-blue-server-1","region":"lon","stats":{"mediaTimeMs":1142550},"multistream":[]}
-...
-```
-
-The `/events` API response implements the
-[Server-Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events)
-protocol using any SSE client. On JavaScript, we recommend using the
-[`eventsource`](https://www.npmjs.com/package/eventsource) NPM package to be
-able to add an `Authorization` header to the API request.
-
-The individual events sent over the SSE stream are all JSON objects and are
-precisely the same low-level objects as published by the services running in the
-Livepeer infrastructure. Some fields are always present, specifically:
-
-- `type`: the unique type of the event, which defines the structure of the rest
-  of the JSON object.
-- `id`: a unique identifier for the event, which SSE clients automatically use
-  to recover a connection without losing events.
-- `timestamp`: the timestamp of the event in milliseconds since the Unix epoch.
-
-You can also get historical events within a time range by specifying the `from`
-and `to` query parameters with Unix millis timestamps. For example:
-
-- `/data/stream/{id}/events?from=1635437394000` to get all events since
-  `Oct 28 16:09:54Z 2021` (exclusively) and stay connected for live events.
-- `/data/stream/{id}/events?from=1635437394000&to=1635447394000` to get all
-  events between `Oct 28 16:09:54Z 2021` (exclusively) and
-  `Oct 28 18:56:34Z 2021` (inclusively).
-
-Finally, we recommend using the events API primarily for debugging purposes, for
-example, to get all available information about a livestream to find any issues.
-The specific events that are published and
-[their respective schemas](https://github.com/livepeer/livepeer-data/tree/main/pkg/data)
-will keep evolving, so they are still subject to changes.
+<Info>
+  We are working on building a first-class solution to monitor stream health
+  using the API. Please reach out to us on Discord if you have any input.
+</Info>
diff --git a/references/contract-addresses.mdx b/references/contract-addresses.mdx
@@ -176,10 +176,10 @@ and all contracts on Ethereum Mainnet besides the above are paused.
 
 ## Ethereum Rinkeby (Confluence)
 
-<Callout type="error">
+<Info>
   The Rinkeby testnet is currently deprecated and the block explorer is not
   available. This will be replaced with Arbitrum Sepolia in Q1 of 2024.
-</Callout>
+</Info>
 
 - BondingManager (Proxy):
   [0xC40df4db2f99e7e235780A93B192F1a934f0c45b](https://rinkeby.etherscan.io/address/0xC40df4db2f99e7e235780A93B192F1a934f0c45b)
