Quick Start Guide
This guide will help you get up and running with Telemetry Harbor quickly. Follow these steps to create your account, set up a harbor, send your first data point, and visualize it in Grafana.
1. Create an Account
- Visit Telemetry Harbor's website and click on "Sign Up".
- Fill in your details and submit the registration form.
- Check your email for a verification link and click it to verify your account.
2. Create a Harbor
- Log in to your Telemetry Harbor dashboard.
- Click on "Create New Harbor" and select General for the type and Free for the specs.
- Once created, you can view the Harbor Details.
3. Get Your API Endpoints and Key
From the Harbor Details page, you will find the necessary credentials:
- Copy the Single Ingestion Endpoint or Batch Ingestion Endpoint as needed.
- Copy your API Key. Keep this secure, as it's used to authenticate your requests.
Your API Key is sensitive. Do not share it publicly or embed it directly in client-side code. Use environment variables for secure storage.
4. Send Your First Data Point
You can send data using either the Single Data Push or Batch Data Push endpoints. The data model and specific cURL examples for sending data to a General Harbor can be found in the Harbor Types documentation.
General Endpoints:
- Single Data Push:
POST https://telemetryharbor.com/api/v2/ingest/ingest/your_harbor_id
- Batch Data Push:
POST https://telemetryharbor.com/api/v2/ingest/ingest/your_harbor_id/batch
Replace your_harbor_id
and your_api_key
with the actual values from your Harbor Details page.
curl -X POST "YOUR_SINGLE_ENDPOINT" \
-H "X-API-Key: "YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"time": "2025-01-18T19:24:00.948Z",
"ship_id": "test_device_single",
"cargo_id": "test_metric",
"value": 123.45}'
5. Visualize Your Data
Telemetry Harbor integrates seamlessly with Grafana for powerful data visualization.
- From the Harbor Details, copy the Grafana Endpoint and Grafana Password.
- Open the Grafana endpoint in your browser and log in using:
- Username: [Your Telemetry Harbor Account Email]
- Password: [The password from Harbor Details]
- You'll find pre-configured dashboards ready for your data.
6. Explore the Demo Dashboard
To get started quickly:
- In Grafana, look for the "Comprehensive Telemetry Dashboard" in your list of dashboards.
- Open it to see example visualizations of telemetry data.
- Use this as a template to create your own custom dashboards.
Congratulations! You've set up your Telemetry Harbor account, sent your first data point, and accessed your visualization tools. From here, you can start ingesting real data and creating custom dashboards to suit your needs.
For more detailed information on data ingestion, API usage, and advanced Grafana configurations, check out our other guides in the documentation.