Skip to content
Merged
Show file tree
Hide file tree
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
33 changes: 33 additions & 0 deletions fabric/api-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: API Documentation
---

# API Documentation

Harper provides automatically generated API documentation page via [Swagger UI](https://github.com/swagger-api/swagger-ui) integration. This page allows developers to explore and test the various API endpoints available in your Harper instance/cluster.

## Accessing the API Documentation

To access the API documentation, navigate to the following URL in your web browser:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To access the API documentation, navigate to the following URL in your web browser:
To access the API documentation, navigate to the `APIs` tab in a specific Cluster.


1. Sign in to your Harper Fabric Studio.
2. Select your Organization and Cluster.
3. Sign in to the Cluster and navigate to the `APIs` tab in the sub-menu.

## API Execution

In order to execute API calls directly from the Swagger UI:

1. Click an endpoint to expand it.
2. Enter the required information in the provided fields under the "Parameters" tab.
3. Scroll down and click the "Execute" button.
4. The server response from the API call will be displayed below, including HTTP status code, and response body.

## Authorize

To authorize API requests, you need to include a valid basic authentication header or bearer authentication token.

1. Click on the "Authorize" button in the Swagger Documentation UI.
2. Choose your preferred authentication method (Basic or Bearer) and enter your credentials or token.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you include a note where a user may get these credentials or tokens from? Like is this something they created when they instantiated the cluster? Maybe relate or link it back to another part of the docs when they created the details to jog their memory.

3. Click the "Authorize" button to apply the authentication key to all subsequent requests.
4. Execute an API call to verify that the authorization was successful.
13 changes: 13 additions & 0 deletions fabric/cluster-creation-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,19 @@ A cluster is a group of instances managed together to run applications and servi
5. \*Confirm or replace the preferred payment method. Add a new card if necessary
6. Cluster will begin provisioning as soon as you complete your selections.

## Editing a Cluster

To edit an existing cluster:

1. Navigate to your organization page.
2. Locate the cluster you want to edit in the list of clusters.
3. Click the three dots menu next to the cluster name and select "Edit" from the dropdown.
4. Make the necessary changes to the cluster configuration such as:
- Performance & Usage
- Modifying the Region location and Estimated P90 Latency
- Adding or removing additional regions.
5. Click the "Save Changes" or "Confirm Payment Details" button to summarize and apply your modifications.

## Harper Deployment Types:

### Colocated:
Expand Down
43 changes: 43 additions & 0 deletions fabric/grafana-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Grafana Integration
---

# Setup Grafana Integration with Harper

Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plugin to integrate with Grafana for enhanced analytics and visualization capabilities.

To install the Harper Grafana integration:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To install the Harper Grafana integration:
To install the Harper Grafana plugin:


1. Navigate to Harper's plug-in inside the [Grafana marketplace](https://grafana.com/grafana/plugins/harperfast-harper-datasource/).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Navigate to Harper's plug-in inside the [Grafana marketplace](https://grafana.com/grafana/plugins/harperfast-harper-datasource/).
1. Navigate to the official Grafana marketplace [Harper plugin](https://grafana.com/grafana/plugins/harperfast-harper-datasource/).

2. Sign-in to your Grafana account. If you do not have an account, you will need to create one.
3. Click the "Get plugin" button.

## Installing on a Local/Self-Hosted Grafana Instance

4. Follow the steps under "[Installing on a local Grafana](https://grafana.com/grafana/plugins/harperfast-harper-datasource/?tab=installation)"

## Connect to Harper

4. Navigate to your Grafana instance URL specified under `Installing Harper on Grafana Cloud`.
5. On the left sidebar, click the `Connections` navigation link and select `Add new connection`
6. In the search bar, type `Harper` to filter the list of available data source plugins.
7. On the top right corner, click the `Add new data source` button.
8. You will be directed to the `Settings` page for the new data source. Configure the following settings:
- **Name**: Provide a name for the data source (e.g., `My Fabric Cluster Analytics`).
- **Operations API URL**: Enter the URL to your Harper Fabric cluster's operations API
- Found in Harper Fabric Studio navigating to the cluster:
- Clicking the three dots and selecting `Copy API Url`.
- Add `:9925` to the end of the URL if not already present.
- **Username**: Enter a username with permission to use the analytics ops in the Operations API.
- **Password**: Enter the password for the specified username.
9. Click the `Save & Test` button to save the data source configuration and test the connection. You should see a message indicating that the data source is working.

## Building Dashboards

Once the Harper data source is configured, you can start building dashboards in Grafana.

## Explore

1. Click on the `Explore` navigation link in the left sidebar.
2. You can now create queries using the Harper data source to visualize your Harper Fabric cluster metrics and logs.
Reference the [Harper Analytics Operations](../docs/developers/operations-api/analytics) for more details on available metrics and query options.
10 changes: 10 additions & 0 deletions sidebarsFabric.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ const sidebarsFabric: SidebarsConfig = {
id: 'managing-applications',
label: 'Managing Applications',
},
{
type: 'doc',
id: 'api-documentation',
label: 'API Documentation',
},
{
type: 'doc',
id: 'database-management',
Expand All @@ -42,6 +47,11 @@ const sidebarsFabric: SidebarsConfig = {
id: 'logging',
label: 'Logging',
},
{
type: 'doc',
id: 'grafana-integration',
label: 'Grafana Integration',
},
{ type: 'autogenerated', dirName: 'fabric' },
],
};
Expand Down