You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/administration/harper-studio/create-account.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Start at the [Harper Studio sign up page](https://studio.harperdb.io/sign-up).
12
12
- Email Address
13
13
- Subdomain
14
14
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)._
Copy file name to clipboardExpand all lines: docs/administration/harper-studio/instances.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ A summary view of all instances within an organization can be viewed by clicking
26
26
1. Fill out Instance Info.
27
27
1. Enter Instance Name
28
28
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._
Copy file name to clipboardExpand all lines: docs/administration/harper-studio/organizations.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ A new organization can be created as follows:
29
29
- Enter Organization Name
30
30
_This is used for descriptive purposes only._
31
31
- 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)._
Copy file name to clipboardExpand all lines: docs/administration/harper-studio/query-instance-data.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ SQL queries can be executed directly through the Harper Studio with the followin
13
13
1. Enter your SQL query in the SQL query window.
14
14
1. Click **Execute**.
15
15
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._
Copy file name to clipboardExpand all lines: docs/administration/logging/standard-logging.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,15 +22,15 @@ For example, a typical log entry looks like:
22
22
23
23
The components of a log entry are:
24
24
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.
34
34
35
35
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.
36
36
@@ -46,7 +46,7 @@ Harper logs can optionally be streamed to standard streams. Logging to standard
46
46
47
47
## Logging Rotation
48
48
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).
Copy file name to clipboardExpand all lines: docs/custom-functions/restarting-server.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Restarting the Server
4
4
5
5
# Restarting the Server
6
6
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.
8
8
9
9
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:
Copy file name to clipboardExpand all lines: docs/deployments/install-harper/linux.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ These instructions assume that the following has already been completed:
20
20
21
21
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.
22
22
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.
Copy file name to clipboardExpand all lines: docs/developers/applications/define-routes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ However, you can specify the path to be `/` if you wish to have your routes hand
22
22
23
23
- 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**.
24
24
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.
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.
41
41
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.**
Copy file name to clipboardExpand all lines: docs/developers/clustering/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,10 @@ A common use case is an edge application collecting and analyzing sensor data th
22
22
23
23
Harper simplifies the architecture of such an application with its bi-directional, table-level replication:
24
24
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.
30
30
31
31
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