Pexip.Monitoring

Pexip.Monitoring is a .Net Core solution consisting of two projects:

• Pexip.Monitoring.Agent is a console application which communicates with the Pexip Infinity API and writes response data to a SQLite database. Specifically the Pexip Management history API is used to collect:
  • conference history data
  • participant history data
  • participant media statistics data
• Pexip.Monitoring.Web is a ASP.NET Core application which represents the data saved by the Agent. It outputs:
  • the total conferences started and ended per hour for a 24 hour period (selectable)
  • the total call qualities per hour for a 24 hour period (selectable)
  • media streams that exceed a configurable packet loss percentage threshold for a 24 hour period (selectable)

Installation

Agent Installation

The agent depends on the Pexip.Lib project found here Pexip.Lib

Create the database:

• Refer to Getting Started with EF Core on ASP.NET Core with a New database

Deploy the agent:

• Publish the project
• Deploy the published project to your desired host, e.g. a Windows Server with the .Net Core Hosting package installed
• Update the appsettings.json with the required details, noting historyHours determines how far back from the point in time the agent is executed that it will request data from the Pexip API.

{
  "dbPath": "Path to the Pexip SQLite DB",
  "pexipManager": {
    "address": "FQDN of the Pexip Manager",
    "username": "Username of the Pexip Manager admin",
    "password": "Password for the Pexip Manager admin"
  },
  "historyHours": 2,
  "logFilePath": "Path to the text file log"
}

• Set up a Windows Scheduled Task or Linux cron job to execute the agent at the desired intervals

Web Installation

Refer to Host and deploy ASP.NET Core for your specific deployment needs.

• Publish the project and deploy to your desired host, e.g. a Windows Server with the .Net Core Hosting package installed
• Update the appsettings.json with the required details

{
  "ConnectionStrings": {
    "DefaultConnection": "Data Source=Path to the Pexip SQLite DB"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*",
  "Configuration": {
    "PacketLossThresholdPercentage": 3,
    "FilterList": [
      "Endpoint One",
      "Endpoint Two"
    ]
  },
  "Serilog": {
    "MinimumLevel": {
      "Default": "Debug",
      "Override": {
        "System": "Information",
        "Microsoft": "Information"
      }
    },
    "WriteTo": [
      { "Name": "File", "Args": { "path": "PATH TO LOG FILE"}}
    ],
    "Enrich": [ "FromLogContext" ]
  }
}

Usage

Once the installation has been completed successfully simply browse to the web interface at the location it was deployed to. Information for the current day is displayed by default. To view information from alternate days use the date box in the top right corner.

Development

Configure the environment to be Development

Command prompt

set ASPNETCORE_ENVIRONMENT=Development

PowerShell

$Env:ASPNETCORE_ENVIRONMENT = "Development"

dbcleanup

dbcleanup is a small utility writtin in go which can be used to:

• count the number of records in each database table
• delete records from all database tables

Both of the above can be provided a duration value in the format of h. e.g. 5h indicating that the operation will include records older then now-5 hours. If duration is not provided 0h is used.

requirements

dbcleanup relies on the cgo package go-sqlite3

gcc is required - refer to the package page above.

For cross compilation a cross compiler is required. An example for a Ubuntu compiling for windows is in the following section. Refer to the issues also noted on the package page, #491 & #560.

compilation

Compiling for Windows from Ubuntu

sudo apt-get install gcc-mingw-w64
env GOOS=windows GOARCH=amd64 CC=x86_64-w64-mingw32-gcc CGO_ENABLED=1 go build

License

Pexip.Monitoring is Open Source software and is released under the Apache license 2.0