Mirrors/wg-portal
1
0
Fork 0
mirror of https://github.com/h44z/wg-portal.git synced 2025-09-14 06:51:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add metric endpoint to public API (#72, #80)
Some checks failed
Docker / Build and Push (push) Has been cancelled
Details
github-pages / deploy (push) Has been cancelled
Details
Docker / release (push) Has been cancelled
Details

Browse Source
This commit is contained in:
Christoph Haas
2025-01-11 23:42:05 +01:00
parent 63d85d8123
commit 2d78fe33b8
7 changed files with 863 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

271
internal/app/api/core/assets/doc/v1_swagger.json
View File

@@ -309,6 +309,180 @@
}
}
},
"/metrics/by-interface/{id}": {
"get": {
"security": [
{
"BasicAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"Metrics"
],
"summary": "Get all metrics for a WireGuard Portal interface.",
"operationId": "metrics_handleMetricsForInterfaceGet",
"parameters": [
{
"type": "string",
"description": "The WireGuard interface identifier.",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.InterfaceMetrics"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/models.Error"
}
}
}
}
},
"/metrics/by-peer/{id}": {
"get": {
"security": [
{
"BasicAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"Metrics"
],
"summary": "Get all metrics for a WireGuard Portal peer.",
"operationId": "metrics_handleMetricsForPeerGet",
"parameters": [
{
"type": "string",
"description": "The peer identifier (public key).",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.PeerMetrics"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/models.Error"
}
}
}
}
},
"/metrics/by-user/{id}": {
"get": {
"security": [
{
"BasicAuth": []
}
],
"produces": [
"application/json"
],
"tags": [
"Metrics"
],
"summary": "Get all metrics for a WireGuard Portal user.",
"operationId": "metrics_handleMetricsForUserGet",
"parameters": [
{
"type": "string",
"description": "The user identifier.",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/models.UserMetrics"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/models.Error"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/models.Error"
}
}
}
}
},
"/peer/by-id/{id}": {
"get": {
"security": [
@@ -1523,6 +1697,26 @@
}
}
},
"models.InterfaceMetrics": {
"type": "object",
"properties": {
"BytesReceived": {
"description": "The number of bytes received by the interface.",
"type": "integer",
"example": 123456789
},
"BytesTransmitted": {
"description": "The number of bytes transmitted by the interface.",
"type": "integer",
"example": 123456789
},
"InterfaceIdentifier": {
"description": "The unique identifier of the interface.",
"type": "string",
"example": "wg0"
}
}
},
"models.Peer": {
"type": "object",
"required": [
@@ -1728,6 +1922,51 @@
}
}
},
"models.PeerMetrics": {
"type": "object",
"properties": {
"BytesReceived": {
"description": "The number of bytes received by the peer.",
"type": "integer",
"example": 123456789
},
"BytesTransmitted": {
"description": "The number of bytes transmitted by the peer.",
"type": "integer",
"example": 123456789
},
"Endpoint": {
"description": "The current endpoint address of the peer.",
"type": "string",
"example": "12.34.56.78"
},
"IsPingable": {
"description": "If this field is set, the peer is pingable.",
"type": "boolean",
"example": true
},
"LastHandshake": {
"description": "The last time the peer initiated a handshake.",
"type": "string",
"example": "2021-01-01T12:00:00Z"
},
"LastPing": {
"description": "The last time the peer responded to a ICMP ping request.",
"type": "string",
"example": "2021-01-01T12:00:00Z"
},
"LastSessionStart": {
"description": "The last time the peer initiated a session.",
"type": "string",
"example": "2021-01-01T12:00:00Z"
},
"PeerIdentifier": {
"description": "The unique identifier of the peer.",
"type": "string",
"example": "xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg="
}
}
},
"models.ProvisioningRequest": {
"type": "object",
"required": [
@@ -1922,6 +2161,38 @@
"example": true
}
}
},
"models.UserMetrics": {
"type": "object",
"properties": {
"BytesReceived": {
"description": "The total number of bytes received by the user. This is the sum of all bytes received by the peers linked to the user.",
"type": "integer",
"example": 123456789
},
"BytesTransmitted": {
"description": "The total number of bytes transmitted by the user. This is the sum of all bytes transmitted by the peers linked to the user.",
"type": "integer",
"example": 123456789
},
"PeerCount": {
"description": "PeerCount represents the number of peers linked to the user.",
"type": "integer",
"example": 2
},
"PeerMetrics": {
"description": "PeerMetrics represents the metrics of the peers linked to the user.",
"type": "array",
"items": {
"$ref": "#/definitions/models.PeerMetrics"
}
},
"UserIdentifier": {
"description": "The unique identifier of the user.",
"type": "string",
"example": "uid-1234567"
}
}
}
},
"securityDefinitions": {

188
internal/app/api/core/assets/doc/v1_swagger.yaml
View File

@@ -239,6 +239,21 @@ definitions:
- PrivateKey
- PublicKey
type: object
models.InterfaceMetrics:
properties:
BytesReceived:
description: The number of bytes received by the interface.
example: 123456789
type: integer
BytesTransmitted:
description: The number of bytes transmitted by the interface.
example: 123456789
type: integer
InterfaceIdentifier:
description: The unique identifier of the interface.
example: wg0
type: string
type: object
models.Peer:
properties:
Addresses:
@@ -383,6 +398,41 @@ definitions:
- InterfaceIdentifier
- PrivateKey
type: object
models.PeerMetrics:
properties:
BytesReceived:
description: The number of bytes received by the peer.
example: 123456789
type: integer
BytesTransmitted:
description: The number of bytes transmitted by the peer.
example: 123456789
type: integer
Endpoint:
description: The current endpoint address of the peer.
example: 12.34.56.78
type: string
IsPingable:
description: If this field is set, the peer is pingable.
example: true
type: boolean
LastHandshake:
description: The last time the peer initiated a handshake.
example: "2021-01-01T12:00:00Z"
type: string
LastPing:
description: The last time the peer responded to a ICMP ping request.
example: "2021-01-01T12:00:00Z"
type: string
LastSessionStart:
description: The last time the peer initiated a session.
example: "2021-01-01T12:00:00Z"
type: string
PeerIdentifier:
description: The unique identifier of the peer.
example: xTIBA5rboUvnH4htodjb6e697QjLERt1NAB4mZqp8Dg=
type: string
type: object
models.ProvisioningRequest:
properties:
InterfaceIdentifier:
@@ -547,6 +597,33 @@ definitions:
example: true
type: boolean
type: object
models.UserMetrics:
properties:
BytesReceived:
description: The total number of bytes received by the user. This is the sum
of all bytes received by the peers linked to the user.
example: 123456789
type: integer
BytesTransmitted:
description: The total number of bytes transmitted by the user. This is the
sum of all bytes transmitted by the peers linked to the user.
example: 123456789
type: integer
PeerCount:
description: PeerCount represents the number of peers linked to the user.
example: 2
type: integer
PeerMetrics:
description: PeerMetrics represents the metrics of the peers linked to the
user.
items:
$ref: '#/definitions/models.PeerMetrics'
type: array
UserIdentifier:
description: The unique identifier of the user.
example: uid-1234567
type: string
type: object
info:
contact:
name: WireGuard Portal Project
@@ -749,6 +826,117 @@ paths:
summary: Create a new interface record.
tags:
- Interfaces
/metrics/by-interface/{id}:
get:
operationId: metrics_handleMetricsForInterfaceGet
parameters:
- description: The WireGuard interface identifier.
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.InterfaceMetrics'
"400":
description: Bad Request
schema:
$ref: '#/definitions/models.Error'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/models.Error'
"404":
description: Not Found
schema:
$ref: '#/definitions/models.Error'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/models.Error'
security:
- BasicAuth: []
summary: Get all metrics for a WireGuard Portal interface.
tags:
- Metrics
/metrics/by-peer/{id}:
get:
operationId: metrics_handleMetricsForPeerGet
parameters:
- description: The peer identifier (public key).
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.PeerMetrics'
"400":
description: Bad Request
schema:
$ref: '#/definitions/models.Error'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/models.Error'
"404":
description: Not Found
schema:
$ref: '#/definitions/models.Error'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/models.Error'
security:
- BasicAuth: []
summary: Get all metrics for a WireGuard Portal peer.
tags:
- Metrics
/metrics/by-user/{id}:
get:
operationId: metrics_handleMetricsForUserGet
parameters:
- description: The user identifier.
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/models.UserMetrics'
"400":
description: Bad Request
schema:
$ref: '#/definitions/models.Error'
"401":
description: Unauthorized
schema:
$ref: '#/definitions/models.Error'
"404":
description: Not Found
schema:
$ref: '#/definitions/models.Error'
"500":
description: Internal Server Error
schema:
$ref: '#/definitions/models.Error'
security:
- BasicAuth: []
summary: Get all metrics for a WireGuard Portal user.
tags:
- Metrics
/peer/by-id/{id}:
delete:
operationId: peers_handleDelete