Merge branch 'develop' into 1067-fe-hardware-monitoring-create-hardware-monitor
This commit is contained in:
commit
683ea81db4
13 files changed
+85
-431
No files matched your search
@@ -37,6 +37,7 @@ const Checkbox = ({
|
|||||||
onChange,
|
onChange,
|
||||||
isDisabled,
|
isDisabled,
|
||||||
}) => {
|
}) => {
|
||||||
|
/* TODO move sizes to theme */
|
||||||
const sizes = { small: "14px", medium: "16px", large: "18px" };
|
const sizes = { small: "14px", medium: "16px", large: "18px" };
|
||||||
const theme = useTheme();
|
const theme = useTheme();
|
||||||
const checkBoxPosition = typeof label === "string" ? {} : { pb: "65px" };
|
const checkBoxPosition = typeof label === "string" ? {} : { pb: "65px" };
|
||||||
@@ -79,6 +80,10 @@ const Checkbox = ({
|
|||||||
fontSize: 13,
|
fontSize: 13,
|
||||||
color: theme.palette.text.tertiary,
|
color: theme.palette.text.tertiary,
|
||||||
},
|
},
|
||||||
|
".MuiFormControlLabel-label.Mui-disabled": {
|
||||||
|
color: theme.palette.text.tertiary,
|
||||||
|
opacity: 0.25,
|
||||||
|
},
|
||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -68,7 +68,7 @@ const Field = forwardRef(
|
|||||||
borderColor: theme.palette.border.dark,
|
borderColor: theme.palette.border.dark,
|
||||||
},
|
},
|
||||||
"&:has(.input-error) .MuiOutlinedInput-root fieldset": {
|
"&:has(.input-error) .MuiOutlinedInput-root fieldset": {
|
||||||
borderColor: theme.palette.error.contrastText,
|
borderColor: theme.palette.error.main,
|
||||||
},
|
},
|
||||||
display: hidden ? "none" : "",
|
display: hidden ? "none" : "",
|
||||||
}}
|
}}
|
||||||
@@ -84,7 +84,7 @@ const Field = forwardRef(
|
|||||||
<Typography
|
<Typography
|
||||||
component="span"
|
component="span"
|
||||||
ml={theme.spacing(1)}
|
ml={theme.spacing(1)}
|
||||||
color={theme.palette.error.contrastText}
|
color={theme.palette.error.main}
|
||||||
>
|
>
|
||||||
*
|
*
|
||||||
</Typography>
|
</Typography>
|
||||||
@@ -191,7 +191,7 @@ const Field = forwardRef(
|
|||||||
component="span"
|
component="span"
|
||||||
className="input-error"
|
className="input-error"
|
||||||
hidden={className? true: false}
|
hidden={className? true: false}
|
||||||
color={theme.palette.error.contrastText}
|
color={theme.palette.error.main}
|
||||||
mt={theme.spacing(2)}
|
mt={theme.spacing(2)}
|
||||||
sx={{
|
sx={{
|
||||||
opacity: 0.8,
|
opacity: 0.8,
|
||||||
|
|||||||
@@ -340,7 +340,8 @@ const CreateInfrastructureMonitor = () => {
|
|||||||
fieldValue={infrastructureMonitor[THRESHOLD_FIELD_PREFIX + type] ?? ""}
|
fieldValue={infrastructureMonitor[THRESHOLD_FIELD_PREFIX + type] ?? ""}
|
||||||
onFieldChange={handleChange}
|
onFieldChange={handleChange}
|
||||||
onFieldBlur={handleBlur}
|
onFieldBlur={handleBlur}
|
||||||
alertUnit="%"
|
// TODO: need BE, maybe in another PR
|
||||||
|
alertUnit={type == "temperature" ? "°C" : "%"}
|
||||||
infrastructureMonitor={infrastructureMonitor}
|
infrastructureMonitor={infrastructureMonitor}
|
||||||
errors={errors}
|
errors={errors}
|
||||||
/>
|
/>
|
||||||
@@ -349,7 +350,7 @@ const CreateInfrastructureMonitor = () => {
|
|||||||
<Typography
|
<Typography
|
||||||
component="span"
|
component="span"
|
||||||
className="input-error"
|
className="input-error"
|
||||||
color={theme.palette.error.text}
|
color={theme.palette.error.main}
|
||||||
mt={theme.spacing(2)}
|
mt={theme.spacing(2)}
|
||||||
sx={{
|
sx={{
|
||||||
opacity: 0.8,
|
opacity: 0.8,
|
||||||
|
|||||||
Vendored
+2
@@ -18,6 +18,8 @@ services:
|
|||||||
environment:
|
environment:
|
||||||
- DB_CONNECTION_STRING=mongodb://mongodb:27017/uptime_db
|
- DB_CONNECTION_STRING=mongodb://mongodb:27017/uptime_db
|
||||||
- REDIS_HOST=redis
|
- REDIS_HOST=redis
|
||||||
|
# volumes:
|
||||||
|
# - /var/run/docker.sock:/var/run/docker.sock:ro
|
||||||
redis:
|
redis:
|
||||||
image: bluewaveuptime/uptime_redis:latest
|
image: bluewaveuptime/uptime_redis:latest
|
||||||
ports:
|
ports:
|
||||||
|
|||||||
Generated
+4
-48
@@ -9,10 +9,9 @@
|
|||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@sendgrid/mail": "^8.1.3",
|
|
||||||
"axios": "^1.7.2",
|
"axios": "^1.7.2",
|
||||||
"bcrypt": "^5.1.1",
|
"bcrypt": "^5.1.1",
|
||||||
"bullmq": "5.25.6",
|
"bullmq": "5.26.2",
|
||||||
"cors": "^2.8.5",
|
"cors": "^2.8.5",
|
||||||
"dockerode": "4.0.2",
|
"dockerode": "4.0.2",
|
||||||
"dotenv": "^16.4.5",
|
"dotenv": "^16.4.5",
|
||||||
@@ -745,41 +744,6 @@
|
|||||||
"node": ">=14"
|
"node": ">=14"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@sendgrid/client": {
|
|
||||||
"version": "8.1.3",
|
|
||||||
"resolved": "https://registry.npmjs.org/@sendgrid/client/-/client-8.1.3.tgz",
|
|
||||||
"integrity": "sha512-mRwTticRZIdUTsnyzvlK6dMu3jni9ci9J+dW/6fMMFpGRAJdCJlivFVYQvqk8kRS3RnFzS7sf6BSmhLl1ldDhA==",
|
|
||||||
"dependencies": {
|
|
||||||
"@sendgrid/helpers": "^8.0.0",
|
|
||||||
"axios": "^1.6.8"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12.*"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/@sendgrid/helpers": {
|
|
||||||
"version": "8.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/@sendgrid/helpers/-/helpers-8.0.0.tgz",
|
|
||||||
"integrity": "sha512-Ze7WuW2Xzy5GT5WRx+yEv89fsg/pgy3T1E3FS0QEx0/VvRmigMZ5qyVGhJz4SxomegDkzXv/i0aFPpHKN8qdAA==",
|
|
||||||
"dependencies": {
|
|
||||||
"deepmerge": "^4.2.2"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">= 12.0.0"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/@sendgrid/mail": {
|
|
||||||
"version": "8.1.3",
|
|
||||||
"resolved": "https://registry.npmjs.org/@sendgrid/mail/-/mail-8.1.3.tgz",
|
|
||||||
"integrity": "sha512-Wg5iKSUOER83/cfY6rbPa+o3ChnYzWwv1OcsR8gCV8SKi+sUPIMroildimlnb72DBkQxcbylxng1W7f0RIX7MQ==",
|
|
||||||
"dependencies": {
|
|
||||||
"@sendgrid/client": "^8.1.3",
|
|
||||||
"@sendgrid/helpers": "^8.0.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=12.*"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/@sideway/address": {
|
"node_modules/@sideway/address": {
|
||||||
"version": "4.1.5",
|
"version": "4.1.5",
|
||||||
"resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz",
|
"resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz",
|
||||||
@@ -1253,9 +1217,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/bullmq": {
|
"node_modules/bullmq": {
|
||||||
"version": "5.25.6",
|
"version": "5.26.2",
|
||||||
"resolved": "https://registry.npmjs.org/bullmq/-/bullmq-5.25.6.tgz",
|
"resolved": "https://registry.npmjs.org/bullmq/-/bullmq-5.26.2.tgz",
|
||||||
"integrity": "sha512-jxpa/DB02V20CqBAgyqpQazT630CJm0r4fky8EchH3mcJAomRtKXLS6tRA0J8tb29BDGlr/LXhlUuZwdBJBSdA==",
|
"integrity": "sha512-UdHBrJoRkpXoF8b/FVEkuRBnaUZoA7+qHQNyTx1n2oNVZ4iWxqGqss+M9xAwXOpBmSNvOSlaBdHpf+5QJTU8GQ==",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cron-parser": "^4.6.0",
|
"cron-parser": "^4.6.0",
|
||||||
@@ -2030,14 +1994,6 @@
|
|||||||
"node": ">=6"
|
"node": ">=6"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/deepmerge": {
|
|
||||||
"version": "4.3.1",
|
|
||||||
"resolved": "https://registry.npmjs.org/deepmerge/-/deepmerge-4.3.1.tgz",
|
|
||||||
"integrity": "sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=0.10.0"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/define-data-property": {
|
"node_modules/define-data-property": {
|
||||||
"version": "1.1.4",
|
"version": "1.1.4",
|
||||||
"resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz",
|
"resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz",
|
||||||
|
|||||||
+1
-2
@@ -12,10 +12,9 @@
|
|||||||
"author": "",
|
"author": "",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@sendgrid/mail": "^8.1.3",
|
|
||||||
"axios": "^1.7.2",
|
"axios": "^1.7.2",
|
||||||
"bcrypt": "^5.1.1",
|
"bcrypt": "^5.1.1",
|
||||||
"bullmq": "5.25.6",
|
"bullmq": "5.26.2",
|
||||||
"cors": "^2.8.5",
|
"cors": "^2.8.5",
|
||||||
"dockerode": "4.0.2",
|
"dockerode": "4.0.2",
|
||||||
"dotenv": "^16.4.5",
|
"dotenv": "^16.4.5",
|
||||||
|
|||||||
@@ -891,6 +891,18 @@ describe("monitorModule", () => {
|
|||||||
url: "https://test.com",
|
url: "https://test.com",
|
||||||
}),
|
}),
|
||||||
};
|
};
|
||||||
|
const mockMonitorDocker = {
|
||||||
|
_id: "monitor123",
|
||||||
|
type: "docker",
|
||||||
|
name: "Test Monitor",
|
||||||
|
url: "https://test.com",
|
||||||
|
toObject: () => ({
|
||||||
|
_id: "monitor123",
|
||||||
|
type: "http",
|
||||||
|
name: "Test Monitor",
|
||||||
|
url: "https://test.com",
|
||||||
|
}),
|
||||||
|
};
|
||||||
|
|
||||||
const checkDocs = [
|
const checkDocs = [
|
||||||
{
|
{
|
||||||
@@ -1004,6 +1016,30 @@ describe("monitorModule", () => {
|
|||||||
expect(result.periodUptime).to.be.a("number");
|
expect(result.periodUptime).to.be.a("number");
|
||||||
expect(result.aggregateData).to.be.an("array");
|
expect(result.aggregateData).to.be.an("array");
|
||||||
});
|
});
|
||||||
|
it("should return monitor stats with calculated values, docker type", async () => {
|
||||||
|
monitorFindByIdStub.returns(mockMonitorDocker);
|
||||||
|
req.query.sortOrder = "desc";
|
||||||
|
const result = await getMonitorStatsById(req);
|
||||||
|
expect(result).to.include.keys([
|
||||||
|
"_id",
|
||||||
|
"type",
|
||||||
|
"name",
|
||||||
|
"url",
|
||||||
|
"uptimeDuration",
|
||||||
|
"lastChecked",
|
||||||
|
"latestResponseTime",
|
||||||
|
"periodIncidents",
|
||||||
|
"periodTotalChecks",
|
||||||
|
"periodAvgResponseTime",
|
||||||
|
"periodUptime",
|
||||||
|
"aggregateData",
|
||||||
|
]);
|
||||||
|
expect(result.latestResponseTime).to.equal(100);
|
||||||
|
expect(result.periodTotalChecks).to.equal(3);
|
||||||
|
expect(result.periodIncidents).to.equal(1);
|
||||||
|
expect(result.periodUptime).to.be.a("number");
|
||||||
|
expect(result.aggregateData).to.be.an("array");
|
||||||
|
});
|
||||||
it("should return monitor stats with calculated values", async () => {
|
it("should return monitor stats with calculated values", async () => {
|
||||||
req.query.sortOrder = "asc";
|
req.query.sortOrder = "asc";
|
||||||
const result = await getMonitorStatsById(req);
|
const result = await getMonitorStatsById(req);
|
||||||
|
|||||||
Whitespace-only changes.
@@ -1,181 +0,0 @@
|
|||||||
---
|
|
||||||
icon: sign-posts-wrench
|
|
||||||
---
|
|
||||||
|
|
||||||
# Installing Uptime Manager
|
|
||||||
|
|
||||||
## Quickstart for users (quick method) <a href="#user-quickstart" id="user-quickstart"></a>
|
|
||||||
|
|
||||||
1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/blob/develop/Docker/dist/docker-compose.yaml)
|
|
||||||
2. Run `docker compose up` to start the application
|
|
||||||
3. Now the application is running at `http://localhost`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>
|
|
||||||
|
|
||||||
{% hint style="info" %}
|
|
||||||
Make sure you change the directory to the specified directories, as paths in commands are relative.
|
|
||||||
{% endhint %}
|
|
||||||
|
|
||||||
### Cloning and initial setup
|
|
||||||
|
|
||||||
1. Clone this repository.
|
|
||||||
2. Checkout the `develop` branch `git checkout develop`
|
|
||||||
|
|
||||||
### Setting up Docker images
|
|
||||||
|
|
||||||
3. Change directory to the `Docker/dev` directory
|
|
||||||
4. Build the docker images by running the `build_images.sh` script
|
|
||||||
5. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
|
|
||||||
6. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
|
|
||||||
|
|
||||||
### Server setup
|
|
||||||
|
|
||||||
6. CD to `Server` directory, and run `npm install`
|
|
||||||
7. While in `Server` directory, create a `.env` file with the [required environmental variables](#env-vars-server)
|
|
||||||
8. While in the `Server` directory, run `npm run dev`
|
|
||||||
|
|
||||||
### Client setup
|
|
||||||
|
|
||||||
9. CD to `Client` directory `run npm install`
|
|
||||||
10. While in the `Client` directory, create a `.env` file with the [required environmental variables](#env-vars-client)
|
|
||||||
11. While in the `Client` directory run `npm run dev`
|
|
||||||
|
|
||||||
### Access the application
|
|
||||||
|
|
||||||
12. Client is now running at `localhost:5173`
|
|
||||||
13. Server is now running at `localhost:5000`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Manual installation <a href="#manual-install" id="manual-install"></a>
|
|
||||||
|
|
||||||
### Client installation <a href="#install-client" id="install-client"></a>
|
|
||||||
|
|
||||||
1. Change directory to the `Client` directory
|
|
||||||
2. Install all dependencies by running `npm install`
|
|
||||||
3. Add a `.env` file to the `Client` directory with the following options:
|
|
||||||
|
|
||||||
#### Environment variables <a href="#env-vars-client" id="env-vars-client"></a>
|
|
||||||
|
|
||||||
| ENV Variable Name | Required/Optional | Type | Description | Accepted Values |
|
|
||||||
| --------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
|
|
||||||
| VITE_APP_API_BASE_URL | Required | `string` | Base URL of server | {host}/api/v1 |
|
|
||||||
| VITE_APP_LOG_LEVEL | Optional | `string` | Log level | `"none"`\|`"error"` \| `"warn"` \| |
|
|
||||||
| VITE_APP_DEMO | Optional | `boolean` | Demo server or not | `true`\|`false` \| |
|
|
||||||
|
|
||||||
#### Starting the Client development server <a href="#start-client" id="start-client"></a>
|
|
||||||
|
|
||||||
1. Run `npm run dev` to start the development server.
|
|
||||||
|
|
||||||
### Server Installation <a href="#install-server" id="install-server"></a>
|
|
||||||
|
|
||||||
1. Change the directory to the `Server` directory
|
|
||||||
2. Install all dependencies by running `npm install`
|
|
||||||
3. Add a `.env` file to the `Server` directory with the following options:
|
|
||||||
|
|
||||||
#### Environment variables <a href="#env-vars-server" id="env-vars-server"></a>
|
|
||||||
|
|
||||||
Configure the server with the following environmental variables:
|
|
||||||
|
|
||||||
<table><thead><tr><th width="239">ENV Variable Name</th><th width="149">Required/Optional</th><th width="116">Type</th><th>Description</th><th>Accepted Values</th></tr></thead><tbody><tr><td>CLIENT_HOST</td><td>Required</td><td><code>string</code></td><td>Frontend Host</td><td></td></tr><tr><td>JWT_SECRET</td><td>Required</td><td><code>string</code></td><td>JWT secret</td><td></td></tr><tr><td>DB_TYPE</td><td>Optional</td><td><code>string</code></td><td>Specify DB to use</td><td><code>MongoDB | FakeDB</code></td></tr><tr><td>DB_CONNECTION_STRING</td><td>Required</td><td><code>string</code></td><td>Specifies URL for MongoDB Database</td><td></td></tr><tr><td>PORT</td><td>Optional</td><td><code>integer</code></td><td>Specifies Port for Server</td><td></td></tr><tr><td>LOGIN_PAGE_URL</td><td>Required</td><td><code>string</code></td><td>Login url to be used in emailing service</td><td></td></tr><tr><td>REDIS_HOST</td><td>Required</td><td><code>string</code></td><td>Host address for Redis database</td><td></td></tr><tr><td>REDIS_PORT</td><td>Required</td><td><code>integer</code></td><td>Port for Redis database</td><td></td></tr><tr><td>TOKEN_TTL</td><td>Optional</td><td><code>string</code></td><td>Time for token to live</td><td>In vercel/ms format https://github.com/vercel/ms</td></tr><tr><td>PAGESPEED_API_KEY</td><td>Optional</td><td><code>string</code></td><td>API Key for PageSpeed requests</td><td></td></tr><tr><td>SYSTEM_EMAIL_HOST</td><td>Required</td><td><code>string</code></td><td>Host to send System Emails From</td><td></td></tr><tr><td>SYSTEM_EMAIL_PORT</td><td>Required</td><td><code>number</code></td><td>Port for System Email Host</td><td></td></tr><tr><td>SYSTEM_EMAIL_ADDRESS</td><td>Required</td><td><code>string</code></td><td>System Email Address</td><td></td></tr><tr><td>SYSTEM_EMAIL_PASSWORD</td><td>Required</td><td><code>string</code></td><td>System Email Password</td><td></td></tr></tbody></table>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Databases <a href="#databases" id="databases"></a>
|
|
||||||
|
|
||||||
This project requires two databases:
|
|
||||||
|
|
||||||
1. **Main application database:** The project uses MongoDB for its primary database, with a MongoDB Docker image provided for easy setup.
|
|
||||||
2. **Redis for queue management:** A Redis database is used for the PingService’s queue system, and a Redis Docker image is included for deployment.
|
|
||||||
|
|
||||||
You may use the included Dockerfiles to spin up databases quickly if you wish.
|
|
||||||
|
|
||||||
**(Optional) Dockerised databases**
|
|
||||||
|
|
||||||
Dockerfiles for the server and databases are located in the `Docker` directory
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>MongoDB Image</summary>
|
|
||||||
|
|
||||||
Location: `Docker/mongoDB.Dockerfile`
|
|
||||||
|
|
||||||
The `Docker/mongo/data` directory should be mounted to the MongoDB container in order to persist data.
|
|
||||||
|
|
||||||
From the `Docker` directory run
|
|
||||||
|
|
||||||
1. Build the image: `docker build -f mongoDB.Dockerfile -t uptime_database_mongo .`
|
|
||||||
2. Run the docker image: `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>Redis Image</summary>
|
|
||||||
|
|
||||||
Location `Docker/redis.Dockerfile`
|
|
||||||
|
|
||||||
the `Docker/redis/data` directory should be mounted to the Redis container in order to persist data.
|
|
||||||
|
|
||||||
From the `Docker` directory run
|
|
||||||
|
|
||||||
1. Build the image: `docker build -f redis.Dockerfile -t uptime_redis .`
|
|
||||||
2. Run the image: `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Starting the development server <a href="#start-server" id="start-server"></a>
|
|
||||||
|
|
||||||
- run `npm run dev` to start the development server
|
|
||||||
|
|
||||||
or,
|
|
||||||
|
|
||||||
- run `node index.js` to start server
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### API documentation <a href="#api-documentation" id="api-documentation"></a>
|
|
||||||
|
|
||||||
Our API is documented in accordance with the [OpenAPI spec](https://www.openapis.org/).
|
|
||||||
|
|
||||||
You can see the documentation on your local development server at http://localhost:{port}/api-docs
|
|
||||||
|
|
||||||
You can also view the documentation on our demo server at [https://uptime-demo.bluewavelabs.ca/api-docs](https://uptime-demo.bluewavelabs.ca/api-docs)
|
|
||||||
|
|
||||||
### Error handling
|
|
||||||
|
|
||||||
Errors are returned in a standard format:
|
|
||||||
|
|
||||||
`{"success": false, "msg": "No token provided"}`
|
|
||||||
|
|
||||||
Errors are handled by error handling middleware and should be thrown with the following parameters
|
|
||||||
|
|
||||||
| Name | Type | Default | Notes |
|
|
||||||
| ------- | --------- | ---------------------- | ------------------------------------ |
|
|
||||||
| status | `integer` | 500 | Standard HTTP codes |
|
|
||||||
| message | `string` | "Something went wrong" | An error message |
|
|
||||||
| service | `string` | "Unknown Service" | Name of service that threw the error |
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```
|
|
||||||
const myRoute = async(req, res, next) => {
|
|
||||||
try{
|
|
||||||
const result = myRiskyOperationHere();
|
|
||||||
}
|
|
||||||
catch(error){
|
|
||||||
error.status = 404
|
|
||||||
error.message = "Resource not found"
|
|
||||||
error.service = service name
|
|
||||||
next(error)
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Errors should not be handled at the controller level and should be left to the middleware to handle.
|
|
||||||
@@ -1,181 +0,0 @@
|
|||||||
---
|
|
||||||
icon: sign-posts-wrench
|
|
||||||
---
|
|
||||||
|
|
||||||
# Installing Uptime Manager
|
|
||||||
|
|
||||||
## Quickstart for users (quick method) <a href="#user-quickstart" id="user-quickstart"></a>
|
|
||||||
|
|
||||||
1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/blob/develop/Docker/dist/docker-compose.yaml)
|
|
||||||
2. Run `docker compose up` to start the application
|
|
||||||
3. Now the application is running at `http://localhost`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>
|
|
||||||
|
|
||||||
{% hint style="info" %}
|
|
||||||
Make sure you change the directory to the specified directories, as paths in commands are relative.
|
|
||||||
{% endhint %}
|
|
||||||
|
|
||||||
### Cloning and initial setup
|
|
||||||
|
|
||||||
1. Clone this repository.
|
|
||||||
2. Checkout the `develop` branch `git checkout develop`
|
|
||||||
|
|
||||||
### Setting up Docker images
|
|
||||||
|
|
||||||
3. Change directory to the `Docker/dev` directory
|
|
||||||
4. Build the docker images by running the `build_images.sh` script
|
|
||||||
5. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
|
|
||||||
6. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
|
|
||||||
|
|
||||||
### Server setup
|
|
||||||
|
|
||||||
6. CD to `Server` directory, and run `npm install`
|
|
||||||
7. While in `Server` directory, create a `.env` file with the [required environmental variables](#env-vars-server)
|
|
||||||
8. While in the `Server` directory, run `npm run dev`
|
|
||||||
|
|
||||||
### Client setup
|
|
||||||
|
|
||||||
9. CD to `Client` directory `run npm install`
|
|
||||||
10. While in the `Client` directory, create a `.env` file with the [required environmental variables](#env-vars-client)
|
|
||||||
11. While in the `Client` directory run `npm run dev`
|
|
||||||
|
|
||||||
### Access the application
|
|
||||||
|
|
||||||
12. Client is now running at `localhost:5173`
|
|
||||||
13. Server is now running at `localhost:5000`
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Manual installation <a href="#manual-install" id="manual-install"></a>
|
|
||||||
|
|
||||||
### Client installation <a href="#install-client" id="install-client"></a>
|
|
||||||
|
|
||||||
1. Change directory to the `Client` directory
|
|
||||||
2. Install all dependencies by running `npm install`
|
|
||||||
3. Add a `.env` file to the `Client` directory with the following options:
|
|
||||||
|
|
||||||
#### Environment variables <a href="#env-vars-client" id="env-vars-client"></a>
|
|
||||||
|
|
||||||
| ENV Variable Name | Required/Optional | Type | Description | Accepted Values |
|
|
||||||
| --------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
|
|
||||||
| VITE_APP_API_BASE_URL | Required | `string` | Base URL of server | {host}/api/v1 |
|
|
||||||
| VITE_APP_LOG_LEVEL | Optional | `string` | Log level | `"none"`\|`"error"` \| `"warn"` \| |
|
|
||||||
| VITE_APP_DEMO | Optional | `boolean` | Demo server or not | `true`\|`false` \| |
|
|
||||||
|
|
||||||
#### Starting the Client development server <a href="#start-client" id="start-client"></a>
|
|
||||||
|
|
||||||
1. Run `npm run dev` to start the development server.
|
|
||||||
|
|
||||||
### Server Installation <a href="#install-server" id="install-server"></a>
|
|
||||||
|
|
||||||
1. Change the directory to the `Server` directory
|
|
||||||
2. Install all dependencies by running `npm install`
|
|
||||||
3. Add a `.env` file to the `Server` directory with the following options:
|
|
||||||
|
|
||||||
#### Environment variables <a href="#env-vars-server" id="env-vars-server"></a>
|
|
||||||
|
|
||||||
Configure the server with the following environmental variables:
|
|
||||||
|
|
||||||
<table><thead><tr><th width="239">ENV Variable Name</th><th width="149">Required/Optional</th><th width="116">Type</th><th>Description</th><th>Accepted Values</th></tr></thead><tbody><tr><td>CLIENT_HOST</td><td>Required</td><td><code>string</code></td><td>Frontend Host</td><td></td></tr><tr><td>JWT_SECRET</td><td>Required</td><td><code>string</code></td><td>JWT secret</td><td></td></tr><tr><td>DB_TYPE</td><td>Optional</td><td><code>string</code></td><td>Specify DB to use</td><td><code>MongoDB | FakeDB</code></td></tr><tr><td>DB_CONNECTION_STRING</td><td>Required</td><td><code>string</code></td><td>Specifies URL for MongoDB Database</td><td></td></tr><tr><td>PORT</td><td>Optional</td><td><code>integer</code></td><td>Specifies Port for Server</td><td></td></tr><tr><td>LOGIN_PAGE_URL</td><td>Required</td><td><code>string</code></td><td>Login url to be used in emailing service</td><td></td></tr><tr><td>REDIS_HOST</td><td>Required</td><td><code>string</code></td><td>Host address for Redis database</td><td></td></tr><tr><td>REDIS_PORT</td><td>Required</td><td><code>integer</code></td><td>Port for Redis database</td><td></td></tr><tr><td>TOKEN_TTL</td><td>Optional</td><td><code>string</code></td><td>Time for token to live</td><td>In vercel/ms format https://github.com/vercel/ms</td></tr><tr><td>PAGESPEED_API_KEY</td><td>Optional</td><td><code>string</code></td><td>API Key for PageSpeed requests</td><td></td></tr><tr><td>SYSTEM_EMAIL_HOST</td><td>Required</td><td><code>string</code></td><td>Host to send System Emails From</td><td></td></tr><tr><td>SYSTEM_EMAIL_PORT</td><td>Required</td><td><code>number</code></td><td>Port for System Email Host</td><td></td></tr><tr><td>SYSTEM_EMAIL_ADDRESS</td><td>Required</td><td><code>string</code></td><td>System Email Address</td><td></td></tr><tr><td>SYSTEM_EMAIL_PASSWORD</td><td>Required</td><td><code>string</code></td><td>System Email Password</td><td></td></tr></tbody></table>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Databases <a href="#databases" id="databases"></a>
|
|
||||||
|
|
||||||
This project requires two databases:
|
|
||||||
|
|
||||||
1. **Main application database:** The project uses MongoDB for its primary database, with a MongoDB Docker image provided for easy setup.
|
|
||||||
2. **Redis for queue management:** A Redis database is used for the PingService’s queue system, and a Redis Docker image is included for deployment.
|
|
||||||
|
|
||||||
You may use the included Dockerfiles to spin up databases quickly if you wish.
|
|
||||||
|
|
||||||
**(Optional) Dockerised databases**
|
|
||||||
|
|
||||||
Dockerfiles for the server and databases are located in the `Docker` directory
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>MongoDB Image</summary>
|
|
||||||
|
|
||||||
Location: `Docker/mongoDB.Dockerfile`
|
|
||||||
|
|
||||||
The `Docker/mongo/data` directory should be mounted to the MongoDB container in order to persist data.
|
|
||||||
|
|
||||||
From the `Docker` directory run
|
|
||||||
|
|
||||||
1. Build the image: `docker build -f mongoDB.Dockerfile -t uptime_database_mongo .`
|
|
||||||
2. Run the docker image: `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
|
|
||||||
<summary>Redis Image</summary>
|
|
||||||
|
|
||||||
Location `Docker/redis.Dockerfile`
|
|
||||||
|
|
||||||
the `Docker/redis/data` directory should be mounted to the Redis container in order to persist data.
|
|
||||||
|
|
||||||
From the `Docker` directory run
|
|
||||||
|
|
||||||
1. Build the image: `docker build -f redis.Dockerfile -t uptime_redis .`
|
|
||||||
2. Run the image: `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Starting the development server <a href="#start-server" id="start-server"></a>
|
|
||||||
|
|
||||||
- run `npm run dev` to start the development server
|
|
||||||
|
|
||||||
or,
|
|
||||||
|
|
||||||
- run `node index.js` to start server
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### API documentation <a href="#api-documentation" id="api-documentation"></a>
|
|
||||||
|
|
||||||
Our API is documented in accordance with the [OpenAPI spec](https://www.openapis.org/).
|
|
||||||
|
|
||||||
You can see the documentation on your local development server at http://localhost:{port}/api-docs
|
|
||||||
|
|
||||||
You can also view the documentation on our demo server at [https://uptime-demo.bluewavelabs.ca/api-docs](https://uptime-demo.bluewavelabs.ca/api-docs)
|
|
||||||
|
|
||||||
### Error handling
|
|
||||||
|
|
||||||
Errors are returned in a standard format:
|
|
||||||
|
|
||||||
`{"success": false, "msg": "No token provided"}`
|
|
||||||
|
|
||||||
Errors are handled by error handling middleware and should be thrown with the following parameters
|
|
||||||
|
|
||||||
| Name | Type | Default | Notes |
|
|
||||||
| ------- | --------- | ---------------------- | ------------------------------------ |
|
|
||||||
| status | `integer` | 500 | Standard HTTP codes |
|
|
||||||
| message | `string` | "Something went wrong" | An error message |
|
|
||||||
| service | `string` | "Unknown Service" | Name of service that threw the error |
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```
|
|
||||||
const myRoute = async(req, res, next) => {
|
|
||||||
try{
|
|
||||||
const result = myRiskyOperationHere();
|
|
||||||
}
|
|
||||||
catch(error){
|
|
||||||
error.status = 404
|
|
||||||
error.message = "Resource not found"
|
|
||||||
error.service = service name
|
|
||||||
next(error)
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
Errors should not be handled at the controller level and should be left to the middleware to handle.
|
|
||||||
@@ -8,24 +8,25 @@ Creating a new monitor involves a few steps, mentioned below. 
|
|||||||
|
|
||||||
### General settings
|
### General settings
|
||||||
|
|
||||||
* **URL to monitor:** Enter the full URL of the website or service you want to monitor.
|
- **URL to monitor:** Enter the full URL of the website or service you want to monitor.
|
||||||
* **Display name:** Optionally, provide a custom name for your monitor. This helps identify it easily in your dashboard.
|
- **Display name:** Optionally, provide a custom name for your monitor. This helps identify it easily in your dashboard.
|
||||||
|
|
||||||
### Checks to perform
|
### Checks to perform
|
||||||
|
|
||||||
* **Website monitoring:** This option uses HTTP(s) to monitor your website or API endpoint. You can choose between HTTPS and HTTP protocols.
|
- **Website monitoring:** This option uses HTTP(s) to monitor your website or API endpoint. You can choose between HTTPS and HTTP protocols.
|
||||||
* **Ping monitoring:** Checks whether your server is available. This option is currently unselected.
|
- **Ping monitoring:** Checks whether your server is available. This option is currently unselected.
|
||||||
|
- **Docker monitoring:** Checks whether a Docker container is running
|
||||||
|
|
||||||
### Incident notifications 
|
### Incident notifications 
|
||||||
|
|
||||||
When there's a new incident, you can choose how to be notified:
|
When there's a new incident, you can choose how to be notified:
|
||||||
|
|
||||||
* Notify via SMS (coming soon)
|
- Notify via SMS (coming soon)
|
||||||
* Notify via email (to the email address you logged in with)
|
- Notify via email (to the email address you logged in with)
|
||||||
* Notify via email to multiple addresses (coming soon)
|
- Notify via email to multiple addresses (coming soon)
|
||||||
|
|
||||||
### Advanced settings
|
### Advanced settings
|
||||||
|
|
||||||
* **Check frequency:** Set how often the system should check your monitor. The current setting is 1 minute.
|
- **Check frequency:** Set how often the system should check your monitor. The current setting is 1 minute.
|
||||||
|
|
||||||
After configuring all settings, click the "Create monitor" button at the bottom right to set up your new monitor.
|
After configuring all settings, click the "Create monitor" button at the bottom right to set up your new monitor.
|
||||||
@@ -10,6 +10,17 @@ icon: sign-posts-wrench
|
|||||||
2. Run `docker compose up` to start the application
|
2. Run `docker compose up` to start the application
|
||||||
3. Now the application is running at `http://localhost`
|
3. Now the application is running at `http://localhost`
|
||||||
|
|
||||||
|
##### Optional Config:
|
||||||
|
|
||||||
|
- If you want to monitor Docker containers, uncomment this line in `docker-compose.yaml`:
|
||||||
|
|
||||||
|
```
|
||||||
|
# volumes:
|
||||||
|
# - /var/run/docker.sock:/var/run/docker.sock:ro
|
||||||
|
```
|
||||||
|
|
||||||
|
This gives the app access to your docker daemon via unix socket, please be aware of what you are doing.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Quickstart for users (remote server) <a href="#user-quickstart" id="user-quickstart"></a>
|
## Quickstart for users (remote server) <a href="#user-quickstart" id="user-quickstart"></a>
|
||||||
@@ -19,6 +30,17 @@ icon: sign-posts-wrench
|
|||||||
3. Run `docker compose up` to start the application
|
3. Run `docker compose up` to start the application
|
||||||
4. Now the application is running at `http://<remote_server_ip>`
|
4. Now the application is running at `http://<remote_server_ip>`
|
||||||
|
|
||||||
|
##### Optional Config:
|
||||||
|
|
||||||
|
- If you want to monitor Docker containers, uncomment this line in `docker-compose.yaml`:
|
||||||
|
|
||||||
|
```
|
||||||
|
# volumes:
|
||||||
|
# - /var/run/docker.sock:/var/run/docker.sock:ro
|
||||||
|
```
|
||||||
|
|
||||||
|
This gives the app access to your docker daemon via unix socket, please be aware of what you are doing.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>
|
## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>
|
||||||
|
|||||||
Generated
-6
@@ -1,6 +0,0 @@
|
|||||||
{
|
|
||||||
"name": "bluewave-uptime",
|
|
||||||
"lockfileVersion": 3,
|
|
||||||
"requires": true,
|
|
||||||
"packages": {}
|
|
||||||
}
|
|
||||||
Reference in new issue
Block a user