Files
checkcle/server/service-operation
Tola Leng 257718e9d6 feat: Add notification, integrate data retention service, and improve i18n support (#164)
* fix(ssl):  Ensure edit form saves notification_id and template_id in DB.

- The SSL edit form was not saving the `notification_id` and `template_id` fields to the PB database when re-assigning the Notification Channel and Alert Template.

* chore(partners): add Cloudflare to Ecosystem & Community Partner section

- Cloudflare has been added to the Ecosystem & Community Partner list to acknowledge their support and contribution.

*  chore(project): update development status and progress

- fix(ssl): ensure edit form saves notification_id and template_id in DB
- feat(notifications): add Notifiarr notification channel (planned)

* feat: Add Notifiarr to notification channels (UI)

- Add Notifiarr as a new channel type in the notification settings. The Notifiarr channel will use the `api_token` field for API key storage in PB.

* feat: Add channel_id field for Notifiarr

- Add channel_id field for Notifiarr to store record of the discord channel_id into the PB.

* feat: Implement Notifiarr notification service

- The Notifiarr notification functionality has been implemented. The alert configuration channel will now use the `api_token` and `channel_id` field for send to the Notifiarr API endpoint.

*  chore(project): update development status and progress

- feat: Add channel_id field for Notifiarr
- feat: Implement Notifiarr notification service

Closes: #133

* feat: add SSL history and Notifiarr notification channel schema

* Fix: Remove duplicate close button

- Removed the duplicate close button from the test email dialog.

* feat: Add Gotify to notification channels

- Add Gotify  as a new channel type in the notification settings. The Gotify channel will use the `api_token` and `server_url` field for API key storage in PB.

* feat: Implement Gotify notification service

- The Gotify notification functionality has been implemented. The alert configuration channel will now use the `api_token` and `server_url` field for send to the Gotify API endpoint.

*  chore(project): update development status and progress
- feat: Add server_url field for Gotify
- feat: Implement Gotify notification service

* refactory(i18n): Improve internationalization configuration and add new translations

- Added multiple new translation items
- Updated the two language files: en and zhcn
- Added type definitions for new translation items in types/services.ts
- Modified some components to use the new translation items

* refactory(i18n): Added architecture import function translation for the "About" page

- Added translation items related to schema import in English, Chinese, and type definition files
- Replaced hard-coded text with new translation items in the AboutSystem component

* refactory(i18n): Added architecture import function translation for the "About" page

- Added translation items related to schema import in English, Chinese, and type definition files
- Replaced hard-coded text with new translation items in the AboutSystem component

* refactory(i18n): Add internationalization support for the service statistics card

* feat: Add NTFY API token field for Token-based authentication to ntfy server

- Add the api_token field for NTFY notifications in both the dialog and service to save it to PB. NTFY schema to include api_token field.

* feat(auth): add token support for ntfy

- Updated the NTFY service to support API token authentication by adding Authorization Bearer header when api_token is provided.

Closes: #89

* refactor(i18n): Added Chinese translations for Create Event and Maintenance

- Supplemented missing Chinese translations
- Added translation entries related to Create Event and Maintenance in both English and Chinese translation files

* chore: deactivate GitHub donation

* refactor(i18n): Optimize internationalization configuration and add new translation items

- Add internationalization support to the LoadingState component
- Implement internationalization translations in the Profile page
- Use internationalized text in the TestEmailDialog component
- Update English and Chinese translation files by adding new translation entries

* docs(readme): deactivate donations, accept only infra support (cloud, domain, hosting)

* feat(i18n): Enhanced internationalization support with variable interpolation

- Refactored the `t` function in LanguageContext to support multiple parameter combinations
- Added variable interpolation feature, allowing variables in translated texts
- Optimized translation logic to improve accuracy and performance
- Enhanced type safety by using TypeScript generics to ensure correct typing

* refactor(i18n): Optimize service pagination internationalization copy

- Added service pagination related copy in English and Chinese translation files
- Updated type definitions to include new translation fields
- Modified the ServicesPagination component to use the newly added translation fields

* docs(README_zhcn): Update documentation content and sponsorship policy

- Update image links in the documentation
- Revise the sponsorship policy to no longer accept individual sponsorships, only enterprise-level collaborations
- Update the display method for supporters and partners
- Add Cloudflare and DigitalOcean as new partners

* feat: Integrate data retention service

- Implemented the data retention service in Go (service-operation) that manages cleanup of old records based on configured retention periods. The service runs once per day to ensure outdated data is removed automatically.

* refactor: Remove manual cleanup buttons from Data Retention Settings

- The three manual cleanup buttons have been removed from the dashboard.
- The data retention service now automatically runs once per day, cleaning up older data based on the configured retention settings.

---------

Co-authored-by: YiZixuan <sqkkyzx@qq.com>
Co-authored-by: YiZixuan <sqkkyzx@outlook.com>
2025-09-13 21:38:38 +07:00
..
2025-06-20 19:42:24 +07:00
2025-06-20 19:42:24 +07:00
2025-06-20 19:42:24 +07:00

CheckCle Microservice Operation

A Go-based microservice for service operations including ICMP ping, DNS resolution, and TCP connectivity testing.

Features

  • ICMP Ping: Full ping functionality with packet statistics
  • DNS Resolution: A, AAAA, MX, and TXT record lookups
  • TCP Connectivity: Port connectivity testing
  • SSL Certificate: SSL Certificate Check
  • REST API endpoints
  • Health check endpoint
  • Configurable via environment variables
  • Comprehensive operation statistics

API Endpoints

POST /operation

Perform various network operations (ping, dns, tcp).

Ping Request:

{
  "type": "ping",
  "host": "google.com",
  "count": 4,
  "timeout": 3
}

DNS Request:

{
  "type": "dns",
  "host": "google.com",
  "query": "A",
  "timeout": 3
}

TCP Request:

{
  "type": "tcp",
  "host": "google.com",
  "port": 443,
  "timeout": 3
}

Response:

{
  "type": "ping",
  "host": "google.com",
  "success": true,
  "response_time": "20ms",
  "packets_sent": 4,
  "packets_recv": 4,
  "packet_loss": 0,
  "min_rtt": "15ms",
  "max_rtt": "25ms",
  "avg_rtt": "20ms",
  "rtts": ["15ms", "20ms", "25ms", "18ms"],
  "start_time": "2023-12-01T10:00:00Z",
  "end_time": "2023-12-01T10:00:03Z"
}

GET /operation/quick

Quick operation test with query parameters.

Examples:

  • /operation/quick?type=ping&host=google.com&count=1
  • /operation/quick?type=dns&host=google.com&query=A
  • /operation/quick?type=tcp&host=google.com&port=443

GET /health

Health check endpoint.

Legacy Endpoints

  • POST /ping - Legacy ping endpoint (backward compatibility)
  • GET /ping/quick - Legacy quick ping endpoint

Operation Types

Ping (ICMP)

  • Type: ping
  • Parameters: host, count, timeout
  • Features: Packet loss calculation, RTT statistics, multiple packets

DNS Resolution

  • Type: dns
  • Parameters: host, query (A, AAAA, MX, TXT), timeout
  • Features: Multiple record types, resolution time tracking

TCP Connectivity

  • Type: tcp
  • Parameters: host, port, timeout
  • Features: Connection testing, response time measurement

Configuration

Environment variables:

  • PORT - Service port (default: 8080)
  • DEFAULT_COUNT - Default ping count (default: 4)
  • DEFAULT_TIMEOUT - Default timeout (default: 3s)
  • MAX_COUNT - Maximum ping count (default: 20)
  • MAX_TIMEOUT - Maximum timeout (default: 30s)
  • ENABLE_LOGGING - Enable logging (default: true)

Running

Local Development

go run main.go

Requirements

  • Go 1.21+
  • Root privileges for ICMP (on Linux)

Note

This service requires elevated privileges to send ICMP packets. Run with sudo on Linux systems or use capabilities:

sudo setcap cap_net_raw=+ep ./service-operation