feat: add location tier presets (3, 6, 15) to Globalping settings
## Changes ### Server - Expand LOCATION_MAP to support city/country-level locations for the 15-location tier (US East/West, Toronto, London, Frankfurt, Amsterdam, Warsaw, Tokyo, Singapore, Mumbai, Sydney, Brazil, Santiago, Johannesburg, Dubai) - Add globalpingLocationsTier field to Settings type, Mongoose model, repository mapper, and Joi validation (valid: 3, 6, 15, default: 6) - Update getGlobalpingLocations endpoint to return locations based on the configured tier from settings - Pass settingsService to MonitorController for tier lookup ### Client - Add tier selector (radio buttons) to SettingsGlobalping component with descriptions for each option: - 3 locations: North America, Europe, Asia - 6 locations: all continents - 15 locations: city-level global coverage - Add rate limits info box explaining credit usage per tier: - Without token: 250 tests/hour - With free token: 500 tests/hour - GitHub sponsors: higher limits - Add all translation keys for tier labels, descriptions, and rate info ## Benefits - Admins can choose the right balance of coverage vs API usage - Rate limit info helps users decide whether they need authentication
This commit is contained in:
1 parent
134c2ebbf4
commit
27c3a9e12b
12 files changed
+202
-10
No files matched your search
@@ -30,6 +30,7 @@ export const useSettingsForm = ({ data = null }: UseSettingsFormOptions = {}) =>
|
||||
checkTTL: data?.checkTTL ?? 30,
|
||||
pagespeedApiKey: "",
|
||||
globalpingApiKey: "",
|
||||
globalpingLocationsTier: data?.globalpingLocationsTier ?? 6,
|
||||
systemEmailPassword: "",
|
||||
};
|
||||
|
||||
|
||||
@@ -2,12 +2,14 @@ import Box from "@mui/material/Box";
|
||||
import Stack from "@mui/material/Stack";
|
||||
import Typography from "@mui/material/Typography";
|
||||
import Button from "@mui/material/Button";
|
||||
import RadioGroup from "@mui/material/RadioGroup";
|
||||
import FormControlLabel from "@mui/material/FormControlLabel";
|
||||
import Radio from "@mui/material/Radio";
|
||||
import ConfigBox from "@/Components/v1/ConfigBox/index.jsx";
|
||||
import TextInput from "@/Components/v1/Inputs/TextInput/index.jsx";
|
||||
import { PasswordEndAdornment } from "@/Components/v1/Inputs/TextInput/Adornments/index.jsx";
|
||||
import { useTheme } from "@emotion/react";
|
||||
import { PropTypes } from "prop-types";
|
||||
import { useState } from "react";
|
||||
import { useTranslation } from "react-i18next";
|
||||
import { Controller } from "react-hook-form";
|
||||
|
||||
@@ -52,7 +54,7 @@ const SettingsGlobalping = ({
|
||||
{...field}
|
||||
label={t("pages.settings.globalpingSettings.labelApiKey")}
|
||||
type={"password"}
|
||||
optionalLabel="(Optional)"
|
||||
optionalLabel={t("pages.settings.globalpingSettings.optionalLabel")}
|
||||
endAdornment={<PasswordEndAdornment />}
|
||||
error={!!fieldState.error}
|
||||
helperText={fieldState.error?.message}
|
||||
@@ -79,6 +81,108 @@ const SettingsGlobalping = ({
|
||||
</Button>
|
||||
</Box>
|
||||
)}
|
||||
|
||||
<Box>
|
||||
<Typography
|
||||
variant="h2"
|
||||
sx={{ mb: theme.spacing(2) }}
|
||||
>
|
||||
{t("pages.settings.globalpingSettings.locationsTierTitle")}
|
||||
</Typography>
|
||||
<Typography sx={{ mb: theme.spacing(8), color: theme.palette.text.secondary }}>
|
||||
{t("pages.settings.globalpingSettings.locationsTierDescription")}
|
||||
</Typography>
|
||||
<Controller
|
||||
name="globalpingLocationsTier"
|
||||
control={control}
|
||||
defaultValue={defaults.globalpingLocationsTier}
|
||||
render={({ field }) => (
|
||||
<RadioGroup
|
||||
value={String(field.value ?? 6)}
|
||||
onChange={(e) => field.onChange(Number(e.target.value))}
|
||||
>
|
||||
<FormControlLabel
|
||||
value="3"
|
||||
control={<Radio />}
|
||||
label={
|
||||
<Box>
|
||||
<Typography fontWeight={500}>
|
||||
{t("pages.settings.globalpingSettings.tier3Label")}
|
||||
</Typography>
|
||||
<Typography variant="body2" color="text.secondary">
|
||||
{t("pages.settings.globalpingSettings.tier3Description")}
|
||||
</Typography>
|
||||
</Box>
|
||||
}
|
||||
sx={{ mb: theme.spacing(4), alignItems: "flex-start" }}
|
||||
/>
|
||||
<FormControlLabel
|
||||
value="6"
|
||||
control={<Radio />}
|
||||
label={
|
||||
<Box>
|
||||
<Typography fontWeight={500}>
|
||||
{t("pages.settings.globalpingSettings.tier6Label")}
|
||||
</Typography>
|
||||
<Typography variant="body2" color="text.secondary">
|
||||
{t("pages.settings.globalpingSettings.tier6Description")}
|
||||
</Typography>
|
||||
</Box>
|
||||
}
|
||||
sx={{ mb: theme.spacing(4), alignItems: "flex-start" }}
|
||||
/>
|
||||
<FormControlLabel
|
||||
value="15"
|
||||
control={<Radio />}
|
||||
label={
|
||||
<Box>
|
||||
<Typography fontWeight={500}>
|
||||
{t("pages.settings.globalpingSettings.tier15Label")}
|
||||
</Typography>
|
||||
<Typography variant="body2" color="text.secondary">
|
||||
{t("pages.settings.globalpingSettings.tier15Description")}
|
||||
</Typography>
|
||||
</Box>
|
||||
}
|
||||
sx={{ alignItems: "flex-start" }}
|
||||
/>
|
||||
</RadioGroup>
|
||||
)}
|
||||
/>
|
||||
</Box>
|
||||
|
||||
<Box
|
||||
sx={{
|
||||
p: theme.spacing(8),
|
||||
borderRadius: theme.spacing(2),
|
||||
border: `1px solid ${theme.palette.primary.lowContrast}`,
|
||||
backgroundColor: theme.palette.tertiary?.main || theme.palette.background.default,
|
||||
}}
|
||||
>
|
||||
<Typography
|
||||
variant="h2"
|
||||
sx={{ mb: theme.spacing(4) }}
|
||||
>
|
||||
{t("pages.settings.globalpingSettings.rateLimitsTitle")}
|
||||
</Typography>
|
||||
<Typography variant="body2" color="text.secondary" sx={{ mb: theme.spacing(4) }}>
|
||||
{t("pages.settings.globalpingSettings.rateLimitsDescription")}
|
||||
</Typography>
|
||||
<Box component="ul" sx={{ m: 0, pl: theme.spacing(8) }}>
|
||||
<Typography component="li" variant="body2" color="text.secondary" sx={{ mb: theme.spacing(2) }}>
|
||||
{t("pages.settings.globalpingSettings.rateLimitNoAuth")}
|
||||
</Typography>
|
||||
<Typography component="li" variant="body2" color="text.secondary" sx={{ mb: theme.spacing(2) }}>
|
||||
{t("pages.settings.globalpingSettings.rateLimitAuth")}
|
||||
</Typography>
|
||||
<Typography component="li" variant="body2" color="text.secondary">
|
||||
{t("pages.settings.globalpingSettings.rateLimitSponsor")}
|
||||
</Typography>
|
||||
</Box>
|
||||
<Typography variant="body2" color="text.secondary" sx={{ mt: theme.spacing(4) }}>
|
||||
{t("pages.settings.globalpingSettings.rateLimitsNote")}
|
||||
</Typography>
|
||||
</Box>
|
||||
</Stack>
|
||||
</ConfigBox>
|
||||
);
|
||||
|
||||
@@ -21,6 +21,7 @@ export interface Settings {
|
||||
systemEmailRequireTLS: boolean;
|
||||
systemEmailRejectUnauthorized: boolean;
|
||||
showURL: boolean;
|
||||
globalpingLocationsTier?: number;
|
||||
singleton: boolean;
|
||||
globalThresholds?: SettingsThresholds;
|
||||
createdAt: string;
|
||||
|
||||
@@ -35,6 +35,7 @@ export const settingsSchema = z.object({
|
||||
.max(365, "Maximum 365 days"),
|
||||
pagespeedApiKey: optionalString(),
|
||||
globalpingApiKey: optionalString(),
|
||||
globalpingLocationsTier: z.coerce.number().optional(),
|
||||
systemEmailHost: z.preprocess(
|
||||
(val) =>
|
||||
val === "" || val === null || val === undefined ? undefined : String(val).trim(),
|
||||
|
||||
@@ -957,10 +957,25 @@
|
||||
"title": "Google PageSpeed API key"
|
||||
},
|
||||
"globalpingSettings": {
|
||||
"description": "Enter your Globalping API key to enable multi-location uptime monitoring. This allows checking your monitors from different geographic regions.",
|
||||
"description": "Configure Globalping to run uptime checks from multiple geographic regions worldwide.",
|
||||
"labelApiKeySet": "API key is set. Click Reset to change it.",
|
||||
"labelApiKey": "Globalping API key",
|
||||
"title": "Globalping API key"
|
||||
"optionalLabel": "(Optional)",
|
||||
"title": "Globalping",
|
||||
"locationsTierTitle": "Global locations",
|
||||
"locationsTierDescription": "Choose how many probe locations are available when creating monitors.",
|
||||
"tier3Label": "3 locations — core regions",
|
||||
"tier3Description": "North America, Europe, Asia",
|
||||
"tier6Label": "6 locations — all continents",
|
||||
"tier6Description": "North America, Europe, Asia, South America, Oceania, Africa",
|
||||
"tier15Label": "15 locations — city level",
|
||||
"tier15Description": "US East, US West, Canada, UK, Germany, Netherlands, Poland, Japan, Singapore, India, Australia, Brazil, Chile, South Africa, UAE",
|
||||
"rateLimitsTitle": "Rate limits",
|
||||
"rateLimitsDescription": "Globalping limits how many tests you can run per hour. Each location check on each monitor uses 1 credit per interval.",
|
||||
"rateLimitNoAuth": "Without a token: 250 tests per hour (no authentication needed)",
|
||||
"rateLimitAuth": "With a free token: 500 tests per hour (sign in at dash.globalping.io)",
|
||||
"rateLimitSponsor": "GitHub sponsors: higher limits based on sponsorship tier + hosting probes",
|
||||
"rateLimitsNote": "For example, 3 monitors with 5 locations each, checked every minute, uses 15 credits per minute (900/hour). Choose your tier accordingly."
|
||||
},
|
||||
"saveButtonLabel": "Save",
|
||||
"statsSettings": {
|
||||
|
||||
@@ -29,7 +29,7 @@ export interface InitializedControllers {
|
||||
export const initializeControllers = (services: InitializedServices): InitializedControllers => {
|
||||
return {
|
||||
authController: new AuthController(services.userService),
|
||||
monitorController: new MonitorController(services.monitorService),
|
||||
monitorController: new MonitorController(services.monitorService, services.settingsService),
|
||||
settingsController: new SettingsController(services.settingsService, services.emailService),
|
||||
checkController: new CheckController(services.checkService),
|
||||
inviteController: new InviteController(services.inviteService),
|
||||
|
||||
@@ -26,16 +26,19 @@ import {
|
||||
} from "./controllerUtils.js";
|
||||
import { AppError } from "@/utils/AppError.js";
|
||||
import { IMonitorService } from "@/service/index.js";
|
||||
import { GLOBALPING_LOCATIONS } from "@/service/infrastructure/globalpingService.js";
|
||||
import { getGlobalpingLocationsByTier } from "@/service/infrastructure/globalpingService.js";
|
||||
import type { ISettingsService } from "@/service/system/settingsService.js";
|
||||
|
||||
const SERVICE_NAME = "monitorController";
|
||||
class MonitorController {
|
||||
static SERVICE_NAME = SERVICE_NAME;
|
||||
|
||||
private monitorService: IMonitorService;
|
||||
private settingsService: ISettingsService;
|
||||
|
||||
constructor(monitorService: IMonitorService) {
|
||||
constructor(monitorService: IMonitorService, settingsService: ISettingsService) {
|
||||
this.monitorService = monitorService;
|
||||
this.settingsService = settingsService;
|
||||
}
|
||||
|
||||
get serviceName() {
|
||||
@@ -390,10 +393,13 @@ class MonitorController {
|
||||
|
||||
getGlobalpingLocations = async (_req: Request, res: Response, next: NextFunction) => {
|
||||
try {
|
||||
const settings = await this.settingsService.getDBSettings();
|
||||
const tier = settings.globalpingLocationsTier ?? 6;
|
||||
const locations = getGlobalpingLocationsByTier(tier);
|
||||
return res.status(200).json({
|
||||
success: true,
|
||||
msg: "Globalping locations retrieved successfully",
|
||||
data: GLOBALPING_LOCATIONS,
|
||||
data: locations,
|
||||
});
|
||||
} catch (error) {
|
||||
next(error);
|
||||
|
||||
@@ -24,6 +24,7 @@ const AppSettingsSchema = new Schema<AppSettingsDocument>(
|
||||
jwtSecret: { type: String },
|
||||
pagespeedApiKey: { type: String },
|
||||
globalpingApiKey: { type: String },
|
||||
globalpingLocationsTier: { type: Number, default: 6 },
|
||||
systemEmailHost: { type: String },
|
||||
systemEmailPort: { type: Number },
|
||||
systemEmailAddress: { type: String },
|
||||
|
||||
@@ -39,6 +39,7 @@ class MongoSettingsRepository implements ISettingsRepository {
|
||||
systemEmailRejectUnauthorized: doc.systemEmailRejectUnauthorized ?? true,
|
||||
showURL: doc.showURL ?? false,
|
||||
globalpingApiKey: doc.globalpingApiKey ?? undefined,
|
||||
globalpingLocationsTier: doc.globalpingLocationsTier ?? 6,
|
||||
singleton: doc.singleton,
|
||||
version: doc.version ?? 1,
|
||||
globalThresholds: doc.globalThresholds ?? undefined,
|
||||
|
||||
@@ -5,16 +5,47 @@ import type { MonitorStatusResponse } from "@/types/network.js";
|
||||
|
||||
const SERVICE_NAME = "GlobalpingService";
|
||||
|
||||
const LOCATION_MAP: Record<string, { continent: string }> = {
|
||||
// Maps location IDs to Globalping API location objects
|
||||
const LOCATION_MAP: Record<string, Record<string, string>> = {
|
||||
// Continent-level (used for 3 and 6 tier)
|
||||
"north-america": { continent: "NA" },
|
||||
europe: { continent: "EU" },
|
||||
asia: { continent: "AS" },
|
||||
"south-america": { continent: "SA" },
|
||||
oceania: { continent: "OC" },
|
||||
africa: { continent: "AF" },
|
||||
// City-level (used for 15 tier)
|
||||
"us-east": { country: "US", state: "VA" },
|
||||
"us-west": { country: "US", state: "CA" },
|
||||
canada: { country: "CA", city: "Toronto" },
|
||||
"uk": { country: "GB", city: "London" },
|
||||
germany: { country: "DE", city: "Frankfurt" },
|
||||
netherlands: { country: "NL", city: "Amsterdam" },
|
||||
poland: { country: "PL", city: "Warsaw" },
|
||||
japan: { country: "JP", city: "Tokyo" },
|
||||
singapore: { country: "SG", city: "Singapore" },
|
||||
india: { country: "IN", city: "Mumbai" },
|
||||
australia: { country: "AU", city: "Sydney" },
|
||||
brazil: { country: "BR" },
|
||||
chile: { country: "CL", city: "Santiago" },
|
||||
"south-africa": { country: "ZA", city: "Johannesburg" },
|
||||
uae: { country: "AE", city: "Dubai" },
|
||||
};
|
||||
|
||||
export const GLOBALPING_LOCATIONS = [
|
||||
interface GlobalpingLocationOption {
|
||||
id: string;
|
||||
label: string;
|
||||
}
|
||||
|
||||
// 3 locations: core regions
|
||||
const LOCATIONS_TIER_3: GlobalpingLocationOption[] = [
|
||||
{ id: "north-america", label: "North America" },
|
||||
{ id: "europe", label: "Europe" },
|
||||
{ id: "asia", label: "Asia" },
|
||||
];
|
||||
|
||||
// 6 locations: all continents
|
||||
const LOCATIONS_TIER_6: GlobalpingLocationOption[] = [
|
||||
{ id: "north-america", label: "North America" },
|
||||
{ id: "europe", label: "Europe" },
|
||||
{ id: "asia", label: "Asia" },
|
||||
@@ -23,6 +54,35 @@ export const GLOBALPING_LOCATIONS = [
|
||||
{ id: "africa", label: "Africa" },
|
||||
];
|
||||
|
||||
// 15 locations: city/country level
|
||||
const LOCATIONS_TIER_15: GlobalpingLocationOption[] = [
|
||||
{ id: "us-east", label: "US East (Virginia)" },
|
||||
{ id: "us-west", label: "US West (California)" },
|
||||
{ id: "canada", label: "Canada (Toronto)" },
|
||||
{ id: "uk", label: "UK (London)" },
|
||||
{ id: "germany", label: "Germany (Frankfurt)" },
|
||||
{ id: "netherlands", label: "Netherlands (Amsterdam)" },
|
||||
{ id: "poland", label: "Poland (Warsaw)" },
|
||||
{ id: "japan", label: "Japan (Tokyo)" },
|
||||
{ id: "singapore", label: "Singapore" },
|
||||
{ id: "india", label: "India (Mumbai)" },
|
||||
{ id: "australia", label: "Australia (Sydney)" },
|
||||
{ id: "brazil", label: "Brazil" },
|
||||
{ id: "chile", label: "Chile (Santiago)" },
|
||||
{ id: "south-africa", label: "South Africa (Johannesburg)" },
|
||||
{ id: "uae", label: "UAE (Dubai)" },
|
||||
];
|
||||
|
||||
const LOCATIONS_BY_TIER: Record<number, GlobalpingLocationOption[]> = {
|
||||
3: LOCATIONS_TIER_3,
|
||||
6: LOCATIONS_TIER_6,
|
||||
15: LOCATIONS_TIER_15,
|
||||
};
|
||||
|
||||
export const getGlobalpingLocationsByTier = (tier: number): GlobalpingLocationOption[] => {
|
||||
return LOCATIONS_BY_TIER[tier] ?? LOCATIONS_TIER_6;
|
||||
};
|
||||
|
||||
class GlobalpingService {
|
||||
static SERVICE_NAME = SERVICE_NAME;
|
||||
|
||||
|
||||
@@ -25,6 +25,7 @@ export interface Settings {
|
||||
systemEmailRejectUnauthorized: boolean;
|
||||
showURL: boolean;
|
||||
globalpingApiKey?: string;
|
||||
globalpingLocationsTier?: number;
|
||||
singleton: boolean;
|
||||
version: number;
|
||||
globalThresholds?: SettingsThresholds;
|
||||
|
||||
@@ -431,6 +431,7 @@ const updateAppSettingsBodyValidation = joi.object({
|
||||
systemEmailRejectUnauthorized: joi.boolean(),
|
||||
|
||||
globalpingApiKey: joi.string().allow(""),
|
||||
globalpingLocationsTier: joi.number().valid(3, 6, 15).optional(),
|
||||
globalThresholds: joi
|
||||
.object({
|
||||
cpu: joi.number().min(1).max(100).allow(""),
|
||||
|
||||
Reference in new issue
Block a user