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

task(devx): Add Tags - Identity #4992

Merged
merged 11 commits into from
Jan 29, 2025
2 changes: 2 additions & 0 deletions docs/content/iota-identity/contribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Contribute to the project
sidebar_label: Contribute
description: Contribute to IOTA Identity by joining the Identity initiative, via the projects GitHub repository, documentation, or sharing your knowledge.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- reference
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: On-chain Identity
description: The IOTA `Identity` Move object.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- explanation
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Authenticated Assets
description: A configurable asset that keeps track of its origin and owner.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- explanation
- getting-started
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
description: The Decentralized Identifiers (DID) standard from W3C is the fundamental standard that supports the concept of a decentralized digital identity. Explore the basic aspects of the DID standard.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- explanation
- identity
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
description: Verifiable credentials are statements about the holder. They can be verified online or in person, and the holder decides who to share them with.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- explanation
- identity
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- explanation
- identity
- verifiable-presentations
---

# Verifiable Presentations

A verifiable presentation is the recommended data format for sharing one or more [verifiable credentials](./verifiable-credentials.mdx).
Expand Down
2 changes: 2 additions & 0 deletions docs/content/iota-identity/getting-started/rust.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_label: Rust
description: Getting started with the IOTA Identity Rust Library.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- identity
- rust
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_label: Universal Resolver
description: Getting started with the IOTA Universal Resolver.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- identity
- did
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Creating a Decentralized Identity
sidebar_label: Create and Publish
description: Create DID Documents and publish them to an IOTA network.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Delete an IOTA Identity
sidebar_label: Delete
description: How to deactivate or destroy an IOTA Identity
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Resolve an IOTA Identity
sidebar_label: Resolve
description: Explain how resolving works including arguments
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_label: Update
description: How DID Documents can be manipulated and how updates should be published
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
description: How to link a domain and a DID
sidebar_label: Create and Verify
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
2 changes: 2 additions & 0 deletions docs/content/iota-identity/how-tos/key-storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Key Storage
sidebar_label: Key Storage
description: Explain the use of the storage interfaces and how they can be implemented
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Create a Verifiable Credential
sidebar_label: Create and Sign
description: Explain how a VC is created and verified
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_label: Revoke
description: Explain how a VC can be revoked
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_label: Selective Disclosure
description: Explain VC with selective disclosure.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_label: Zero Knowledge Selective Disclosure
description: Zero Knowledge selectively disclosable VCs.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
sidebar_label: Create and Validate
description: Explain how a VP is created and verified
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- how-to
- identity
Expand Down
2 changes: 2 additions & 0 deletions docs/content/iota-identity/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
description: The most important concepts that developers will need to know to utilize IOTA Identity to its full potential.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- reference
- identity
Expand Down
46 changes: 46 additions & 0 deletions docs/content/operator/telemetry/iota-telemetry.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Telemetry
description: Collects data from the node and sends it to Google Analytics for monitoring and analysis.
---

import Quiz from '@site/src/components/Quiz';
import questions from '/json/node-operators/telemetry/iota-telemetry.json';

The `iota-telemetry` crate is used to collect data from a node, package it into structured events and send it to Google
Analytics (GA). It uses the GA4 Measurement Protocol, which allows backends to send custom event data to track node
performance and other metrics.
Access to the telemetry data is restricted to users with appropriate permissions in the GA account.

## Constants

The library defines following constants:
- `GA_API_SECRET`: The API secret for authenticating with GA.
- `GA_EVENT_NAME`: The name of the telemetry event being tracked.
- `GA_MEASUREMENT_ID`: The measurement ID for the GA property.
- `GA_URL`: The endpoint URL for sending data to GA.
- `HARDCODED_CLIENT_ID`: A hardcoded client ID required for the GA4 Measurement Protocol.
- `IPLOOKUP_URL`: The URL used to retrieve the node's public IP address.
- `UNKNOWN_STRING`: A fallback string used when data retrieval fails.

## Data Types

To organize the telemetry data that is to be sent:
- `TelemetryEvent`: Represents a single event with a name and a set of parameters.
- `TelemetryPayload`: Represents the payload to be sent, containing a client ID and a list of telemetry events.
- `IpResponse`: Represents the structure of the IP lookup service response.

## Sending the Event

The `send_telemetry_event` function collects the data from an `AuthorityState`.
It retrieves:
* The current git revision using `env!("CARGO_PKG_VERSION")`.
* The public IP address by calling the `get_ip` helper function.
* The `get_ip` function retrieves the node's public IP address by making a GET request to `https://api.ipify.org`. If the request fails, it returns the `UNKNOWN_STRING` constant.
* The chain identifier from the node state.
* The epoch time.

After retrieving all data, `send_telemetry_event` constructs a `TelemetryEvent` and wraps it into
a `TelemetryPayload` type containing the hardcoded client ID. Then, the payload will be sent to GA as an HTTP POST request
with content type JSON, which can be visualized and analyzed in the GA dashboard.

<Quiz questions={questions} />
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: IOTA DID Method Specification v2.0
sidebar_label: DID Method
description: How IOTA Identity implements the Decentralized Identifiers Standard on the IOTA Tangle.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- reference
- identity
Expand Down
2 changes: 2 additions & 0 deletions docs/content/references/iota-identity/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Specifications Overview
sidebar_label: Overview
description: Provide overview of the specifications
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- reference
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Revocation Bitmap
sidebar_label: Revocation Bitmap
description: The specification for the embedded revocation bitmap.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- reference
- identity
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Revocation Timeframe 2024
sidebar_label: Revocation Timeframe 2024
description: The specification for an embeddable time-based revocation method - `RevocationTimeframe2024`.
image: /img/identity/icon.png
teams:
- iotaledger/identity
tags:
- reference
- identity
Expand Down
4 changes: 4 additions & 0 deletions docs/content/tags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ verifiable-credentials:
label: Verifiable Credentials
description: Verifiable Credentials.

verifiable-presentations:
label: Verifiable Presentations
description: Verifiable Presentations.

verification-method:
label: Verification Method
description: Verification Method.
Expand Down
Loading