https://github.com/vapor-community/VaporMonitoring

Monitoring for Vapor
https://github.com/vapor-community/VaporMonitoring

metrics monitoring prometheus prometheus-metrics swiftmetrics vapor vapor-3 vapor-service

Last synced: 4 months ago
JSON representation

Monitoring for Vapor

• Host: GitHub
• URL: https://github.com/vapor-community/VaporMonitoring
• Owner: vapor-community
• License: mit
• Created: 2018-05-29T17:36:00.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-10-14T04:16:34.000Z (over 5 years ago)
• Last Synced: 2024-10-13T16:41:05.894Z (4 months ago)
• Topics: metrics, monitoring, prometheus, prometheus-metrics, swiftmetrics, vapor, vapor-3, vapor-service
• Language: Swift
• Size: 330 KB
• Stars: 46
• Watchers: 6
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VaporMonitoring

[![Vapor 3](https://img.shields.io/badge/vapor-3.0-blue.svg?style=flat)](https://vapor.codes)

[![Swift 4.1](https://img.shields.io/badge/swift-4.2-orange.svg?style=flat)](http://swift.org)

##

`VaporMonitoring` is a Vapor 3 package for monitoring and providing metrics for your Vapor application. Built on top op [SwiftMetrics](https://github.com/RuntimeTools/SwiftMetrics) and [SwiftPrometheus](https://github.com/MrLotU/SwiftPrometheus). Vapor Monitoring provides the default SwiftMetrics metrics along with request specific metrics. Metrics are exposed using Prometheus. 

## Installation

Vapor Monitoring can be installed using SPM

```swift

.package(url: "https://github.com/vapor-community/VaporMonitoring.git", from: "2.0.0")

```

## Usage

Vapor Monitoring is easy to use, it requires only a few lines of code.

Vapor Monitoring requires a few things to work correclty, a `MonitoredRouter` and a `MonitoredResponder` are the most important ones.

To set up your monitoring, in your `Configure.swift` file, add the following: 

```swift

let router = try VaporMonitoring.setupMonitoring(&config, &services)

services.register(router, as: Router.self)

```

What this does is load VaporMonitoring with the default configuration. This includes adding all required services to your apps services & setting some configuration prefferences to use the `MonitoredResponder` and `MonitoredRouter`.

By default, your prometheus metrics will be served at `host:port/metrics` and routes that don't have a routing closure, will be ignored to avoid exploding your prometheus logs. You can however customize this.

To customize your monitoring, add this to `Configure.swift`

```swift

let monitoringConfg = MonitoringConfig(prometheusRoute: "customRoute", onlyBuiltinRoutes: false)

let router = try VaporMonitoring.setupMonitoring(&config, &services, monitoringConfg)

services.register(router, as: Router.self)

```

In this case, you'd have your prometheus metrics at `host:port/customRoute`.