Skip to content

Commit 00fd266

Browse files
committed
formatting fixes
1 parent 26e1058 commit 00fd266

File tree

202 files changed

+2907
-3021
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+2907
-3021
lines changed

docs/administration/harper-studio/create-account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Start at the [Harper Studio sign up page](https://studio.harperdb.io/sign-up).
1212
- Email Address
1313
- Subdomain
1414

15-
_Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain demo and instance name “c1” the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com)._
15+
_Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain "demo" and instance name "c1" the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com)._
1616

1717
- Coupon Code (optional)
1818

docs/administration/harper-studio/instances.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A summary view of all instances within an organization can be viewed by clicking
2626
1. Fill out Instance Info.
2727
1. Enter Instance Name
2828

29-
_This will be used to build your instance URL. For example, with subdomain demo and instance name “c1” the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com). The Instance URL will be previewed below._
29+
_This will be used to build your instance URL. For example, with subdomain "demo" and instance name "c1" the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com). The Instance URL will be previewed below._
3030

3131
1. Enter Instance Username
3232

docs/administration/harper-studio/organizations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ A new organization can be created as follows:
2929
- Enter Organization Name
3030
_This is used for descriptive purposes only._
3131
- Enter Organization Subdomain
32-
_Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain demo and instance name “c1” the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com)._
32+
_Part of the URL that will be used to identify your Harper Cloud Instances. For example, with subdomain "demo" and instance name "c1" the instance URL would be: [https://c1-demo.harperdbcloud.com](https://c1-demo.harperdbcloud.com)._
3333
1. Click Create Organization.
3434

3535
## Delete an Organization

docs/administration/harper-studio/query-instance-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ SQL queries can be executed directly through the Harper Studio with the followin
1313
1. Enter your SQL query in the SQL query window.
1414
1. Click **Execute**.
1515

16-
_Please note, the Studio will execute the query exactly as entered. For example, if you attempt to `SELECT _` from a table with millions of rows, you will most likely crash your browser.\*
16+
_Please note, the Studio will execute the query exactly as entered. For example, if you attempt to `SELECT _` from a table with millions of rows, you will most likely crash your browser._
1717

1818
## Browse Query Results Set
1919

docs/administration/logging/standard-logging.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ For example, a typical log entry looks like:
2222

2323
The components of a log entry are:
2424

25-
- timestamp - This is the date/time stamp when the event occurred
26-
- level - This is an associated log level that gives a rough guide to the importance and urgency of the message. The available log levels in order of least urgent (and more verbose) are: `trace`, `debug`, `info`, `warn`, `error`, `fatal`, and `notify`.
27-
- thread/ID - This reports the name of the thread and the thread ID that the event was reported on. Note that NATS logs are recorded by their process name and there is no thread id for them since they are a separate process. Key threads are:
28-
- main - This is the thread that is responsible for managing all other threads and routes incoming requests to the other threads
29-
- http - These are the worker threads that handle the primary workload of incoming HTTP requests to the operations API and custom functions.
30-
- Clustering\* - These are threads and processes that handle replication.
31-
- job - These are job threads that have been started to handle operations that are executed in a separate job thread.
32-
- tags - Logging from a custom function will include a "custom-function" tag in the log entry. Most logs will not have any additional tags.
33-
- message - This is the main message that was reported.
25+
- `timestamp` - This is the date/time stamp when the event occurred
26+
- `level` - This is an associated log level that gives a rough guide to the importance and urgency of the message. The available log levels in order of least urgent (and more verbose) are: `trace`, `debug`, `info`, `warn`, `error`, `fatal`, and `notify`.
27+
- `thread/ID` - This reports the name of the thread and the thread ID that the event was reported on. Note that NATS logs are recorded by their process name and there is no thread id for them since they are a separate process. Key threads are:
28+
- `main` - This is the thread that is responsible for managing all other threads and routes incoming requests to the other threads
29+
- `http` - These are the worker threads that handle the primary workload of incoming HTTP requests to the operations API and custom functions.
30+
- `Clustering` - These are threads and processes that handle replication.
31+
- `job` - These are job threads that have been started to handle operations that are executed in a separate job thread.
32+
- `tags` - Logging from a custom function will include a "custom-function" tag in the log entry. Most logs will not have any additional tags.
33+
- `message` - This is the main message that was reported.
3434

3535
We try to keep logging to a minimum by default, to do this the default log level is `error`. If you require more information from the logs, increasing the log level down will provide that.
3636

@@ -46,7 +46,7 @@ Harper logs can optionally be streamed to standard streams. Logging to standard
4646

4747
## Logging Rotation
4848

49-
Log rotation allows for managing log files, such as compressing rotated log files, archiving old log files, determining when to rotate, and the like. This will allow for organized storage and efficient use of disk space. For more information see logging in our [config docs](../../deployments/configuration).
49+
Log rotation allows for managing log files, such as compressing rotated log files, archiving old log files, determining when to rotate, and the like. This will allow for organized storage and efficient use of disk space. For more information see "logging" in our [config docs](../../deployments/configuration).
5050

5151
## Read Logs via the API
5252

docs/custom-functions/restarting-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Restarting the Server
44

55
# Restarting the Server
66

7-
One way to manage Custom Functions is through [Harper Studio](../harper-studio/). It performs all the necessary operations automatically. To get started, navigate to your instance in Harper Studio and click the subnav link for functions. If you have not yet enabled Custom Functions, it will walk you through the process. Once configuration is complete, you can manage and deploy Custom Functions in minutes.
7+
One way to manage Custom Functions is through [Harper Studio](../harper-studio/). It performs all the necessary operations automatically. To get started, navigate to your instance in Harper Studio and click the subnav link for "functions". If you have not yet enabled Custom Functions, it will walk you through the process. Once configuration is complete, you can manage and deploy Custom Functions in minutes.
88

99
For any changes made to your routes, helpers, or projects, you’ll need to restart the Custom Functions server to see them take effect. Harper Studio does this automatically whenever you create or delete a project, or add, edit, or edit a route or helper. If you need to start the Custom Functions server yourself, you can use the following operation to do so:
1010

docs/deployments/install-harper/linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ These instructions assume that the following has already been completed:
2020

2121
While you will need to access Harper through port 9925 for the administration through the operations API, and port 9932 for clustering, for higher level of security, you may want to consider keeping both of these ports restricted to a VPN or VPC, and only have the application interface (9926 by default) exposed to the public Internet.
2222

23-
For this example, we will use an AWS Ubuntu Server 22.04 LTS m5.large EC2 Instance with an additional General Purpose SSD EBS volume and the default ubuntu user account.
23+
For this example, we will use an AWS Ubuntu Server 22.04 LTS m5.large EC2 Instance with an additional General Purpose SSD EBS volume and the default "ubuntu" user account.
2424

2525
---
2626

docs/developers/applications/caching.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ While you can provide a single expiration time, there are actually several expir
2222

2323
You can provide a single expiration and it defines the behavior for all three. You can also provide three settings for expiration, through table directives:
2424

25-
- expiration - The amount of time until a record goes stale.
26-
- eviction - The amount of time after expiration before a record can be evicted (defaults to zero).
27-
- scanInterval - The interval for scanning for expired records (defaults to one quarter of the total of expiration and eviction).
25+
- `expiration` - The amount of time until a record goes stale.
26+
- `eviction` - The amount of time after expiration before a record can be evicted (defaults to zero).
27+
- `scanInterval` - The interval for scanning for expired records (defaults to one quarter of the total of expiration and eviction).
2828

2929
## Define External Data Source
3030

docs/developers/applications/define-routes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ However, you can specify the path to be `/` if you wish to have your routes hand
2222

2323
- The route below, using the default config, within the **dogs** project, with a route of **breeds** would be available at **http:/localhost:9926/dogs/breeds**.
2424

25-
In effect, this route is just a pass-through to Harper. The same result could have been achieved by hitting the core Harper API, since it uses **hdbCore.preValidation** and **hdbCore.request**, which are defined in the helper methods section, below.
25+
In effect, this route is just a pass-through to Harper. The same result could have been achieved by hitting the core Harper API, since it uses **hdbCore.preValidation** and **hdbCore.request**, which are defined in the "helper methods" section, below.
2626

2727
```javascript
2828
export default async (server, { hdbCore, logger }) => {
@@ -39,7 +39,7 @@ export default async (server, { hdbCore, logger }) => {
3939

4040
For endpoints where you want to execute multiple operations against Harper, or perform additional processing (like an ML classification, or an aggregation, or a call to a 3rd party API), you can define your own logic in the handler. The function below will execute a query against the dogs table, and filter the results to only return those dogs over 4 years in age.
4141

42-
**IMPORTANT: This route has NO preValidation and uses hdbCore.requestWithoutAuthentication, which- as the name implies- bypasses all user authentication. See the security concerns and mitigations in the helper methods section, below.**
42+
**IMPORTANT: This route has NO preValidation and uses hdbCore.requestWithoutAuthentication, which- as the name implies- bypasses all user authentication. See the security concerns and mitigations in the "helper methods" section, below.**
4343

4444
```javascript
4545
export default async (server, { hdbCore, logger }) => {

docs/developers/clustering/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ A common use case is an edge application collecting and analyzing sensor data th
2222

2323
Harper simplifies the architecture of such an application with its bi-directional, table-level replication:
2424

25-
- The edge instance subscribes to a thresholds table on the cloud instance, so the application only makes localhost calls to get the thresholds.
26-
- The application continually pushes sensor data into a sensor_data table via the localhost API, comparing it to the threshold values as it does so.
27-
- When a threshold violation occurs, the application adds a record to the alerts table.
28-
- The application appends to that record array sensor_data entries for the 60 seconds (or minutes, or days) leading up to the threshold violation.
29-
- The edge instance publishes the alerts table up to the cloud instance.
25+
- The edge instance subscribes to a "thresholds" table on the cloud instance, so the application only makes localhost calls to get the thresholds.
26+
- The application continually pushes sensor data into a "sensor_data" table via the localhost API, comparing it to the threshold values as it does so.
27+
- When a threshold violation occurs, the application adds a record to the "alerts" table.
28+
- The application appends to that record array "sensor_data" entries for the 60 seconds (or minutes, or days) leading up to the threshold violation.
29+
- The edge instance publishes the "alerts" table up to the cloud instance.
3030

3131
By letting Harper focus on the fault-tolerant logistics of transporting your data, you get to write less code. By moving data only when and where it’s needed, you lower storage and bandwidth costs. And by restricting your app to only making local calls to Harper, you reduce the overall exposure of your application to outside forces.

0 commit comments

Comments
 (0)