Aphorio - Features

Features Overview

This page provides an extremely brief informational summary of features and content provided by this application. More detailed content, technical documentation, and relevant references are provided directly in the dashboard page HTML for immediate availability using the application.

All dashboard content features are provided a la carte using a features.json file. To exclude any features, in both content and data services, simply set a given feature value to false and restart the application. All specified service interface definitions can be found in file /lib/typescript/service_registry.d.ts. More detailed information about how this application publishes and consumes services please see the services page.

The feature list is provided in the order presented in the Aphorio dashboard.

Web Servers (Services)

Displays a list of running web servers color coded by operating status.

Dashboard user interface code: /lib/dashboard/sections/servers_web.ts
Service code: /lib/server/index.ts
Respective services(s): services_server_action

Docker Compose (Services)

This section provides a list of avialable docker containers gathered from the list of compose file stored in the project's compose directory as well as any other containers currently running, a read-only shell detailing current status of operations, and any docker specific environmental variables.

Each container is configured using docker compose's yaml format. The compose yaml is followed by a meta-data summary populated from the container's downloaded image and ports mapped to the operating system.

Please note that on Linux operating systems Docker executes with elevated user access, which means this application must execute with elevated privilege to support this feature. On Windows Docker requires activation of Windows Subsystem for Linux (WSL), which requires elevated access to execute, but otherwise docker support does not require elevated access.

Dashboard user interface code: /lib/dashboard/sections/compose_containers.ts
Service code: /lib/services/docker.ts
Respective services(s): services_compose_container, store_string

Message Inspection (Services)

The Message Inspection tool allows the ability to read message data that traverses web server sockets or information written to docker logs. This tool provides throttling restrictions because some docker containers output information too fast to display in the browser and could result in browser crashes. The same instabilities are also observed with high frequency web server sockets.

Dashboard user interface code: /lib/dashboard/sections/message_inspection.ts
Service code: /lib/services/message_inspection.ts
Respective services(s): services_message_inspection

Resource Statistics (Services)

A series of graphs displaying comparative resource consumption for each running web server and docker container. These graphs are customizable by frequency and number of data points.

Dashboard user interface code: /lib/dashboard/sections/statistics_resources.ts
Service code: /lib/services/statistics_resources.ts
Respective services(s): services_statistics_change, services_statistics_data

App Ports (Application)

Provides a list of all ports consumed by managed web servers and running docker containers with additional information about the service id and port type.

Dashboard user interface code: /lib/dashboard/sections/ports_application.ts
Service code: /lib/services/ports_application.ts
Respective services(s): services_ports_application

App TCP Sockets (Application)

Displays a list of TCP sockets generated or managed by this application and all associated data points this application uses to manage and map those sockets..

Dashboard user interface code: /lib/dashboard/sections/sockets_application_tcp.ts
Service code: /lib/services/socket_list.ts
Respective services(s): services_socket_application

App UDP Sockets (Application)

Displays a list of UDP sockets generated or managed by this application and all associated data points this application uses to manage and map those sockets..

Dashboard user interface code: /lib/dashboard/sections/sockets_application_udp.ts
Service code: /lib/services/socket_list.ts
Respective services(s): services_socket_application

Interfaces (Network)

A list of all network interface data known to the operating system, including both physical and virtual interfaces.

Dashboard user interface code: /lib/dashboard/sections/interfaces.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_intr

OS TCP Sockets (Network)

A list of all TCP sockets current open on the given operating system. The table includes address and port for both sides of the socket, associated process id, and process name.

Dashboard user interface code: /lib/dashboard/sections/sockets_os_tcp.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_sock

OS UDP Sockets (Network)

A list of all UDP sockets current open on the given operating system. The table includes address and port for both sides of the socket, associated process id, and process name.

Dashboard user interface code: /lib/dashboard/sections/sockets_os_udp.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_sock

OS / Machine (System)

Provides detailed information about the machine hardware, operating system, and application run time properties.

Dashboard user interface code: /lib/dashboard/sections/os_machine.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_main

Devices (System)

A list of external devices and peripherals attached to the current machine operating system.

Dashboard user interface code: /lib/dashboard/sections/devices.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_devs

Disks (System)

This section provides information on attached physical storage disks, their partitions, and any nested partitions. This information includes space consumed versus space available, partition status, disk make/model, and additional information gathered from the operating system.

Dashboard user interface code: /lib/dashboard/sections/disks.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_disk

Processes (System)

A list of processes running on the given server's operating system and additional information including owning user, memory consumption, and more.

Dashboard user interface code: /lib/dashboard/sections/processes.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_proc

OS Services (System)

A list of all operating system services by service name, operating status, and provided description text.

Dashboard user interface code: /lib/dashboard/sections/services_os.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_serv

Users (System)

A table of user account data from the operating system.

Dashboard user interface code: /lib/dashboard/sections/users.ts
Service code: /lib/services/os.ts
Respective services(s): services_os_all, services_os_user

Terminal (Tools)

Provides a command terminal to the Aphorio dashboard browser interface that fully maps to a selection of command terminals installed in the host operating system.

Dashboard user interface code: /lib/dashboard/sections/terminal.ts
Service code: /lib/services/terminal.ts
Respective services(s): none, uses a dedicated socket

File System (Tools)

Provides read only navigation of the local machine operating system from the dashboard tool in a web browser. The file system data is presented in a format that resembles most modern GUI file explorer applications but it also optionally provides the number of child artifacts in listed directories and total recursive directory size. Text-based files will present their content to screen and certain media files supported by the given web browser will display in a provided media player.

Dashboard user interface code: /lib/dashboard/sections/file_system.ts
Service code: /lib/services/fileSystem.ts
Respective services(s): services_file_system

DNS Query (Tools)

A simplistic tool to look query the DNS system for domain related information by all or specified record type. This tool also allows reverse DNS queries to search an IP address for related domain assignments.

Dashboard user interface code: /lib/dashboard/sections/dns_query.ts
Service code: /lib/services/dns.ts
Respective services(s): services_dns_input, services_dns_output, services_dns_reverse

Hash / Base64 (Tools)

A simple tool to provide hash sequences or text or raw files from the server's file system. The hash sequences are all sequences supported by OpenSSH and the output is either base64 or hexadecimal. This tool also provides a base64 capability to encode text or decode base64 encodings.

Dashboard user interface code: /lib/dashboard/sections/hash.ts
Service code: /lib/services/hash.ts
Respective services(s): services_hash

Notes (Tools)

This feature provides a textarea element for writing down thoughts. On blur of element focus or after 10 second of inactivity the notes are automatically saved to the applications configuration file and broadcast across all sockets incase the Aphorio dashboard is open on various tabs, browsers, or machines.

Dashboard user interface code: /lib/dashboard/sections/notes.ts
Service code: /lib/services/notes.ts
Respective services(s): services_notes

HTTP Test (Network Tests)

A connection test utility for the HTTP protocol, much like the popular Postman tool, except this tool is low level making use of raw request headers in the original text format. The response also displays the raw response header text as well chunk data if the response is chunk encoded.

Dashboard user interface code: /lib/dashboard/sections/test_http.ts
Service code: /lib/services/test_http.ts
Respective services(s): services_test_http

WebSocket Test (Network Tests)

A connection test utility for the WebSocket protocol. Allows specific low level access to each phase of WebSockets: handshake and message transfer.

Dashboard user interface code: /lib/dashboard/sections/test_websocket.ts
Service code: /lib/services/websocket.ts
Respective services(s): services_websocket_handshake, services_websocket_message, services_websocket_status

Performance Test (Network Tests)

A connection test for both HTTP and WebSockets with granular control for experimentation, such as message segmentation size.

Dashboard user interface code: /lib/dashboard/sections/test_performance.ts
Service code: /lib/services/test_performance.ts
Respective services(s): services_test_performance_input, services_test_performance_output

Application Logs (Informational)

The Application Logs section provides event managing listing logged events per web server, docker container interaction, and various other internal events from the application.

Dashboard user interface code: /lib/dashboard/sections/application_logs.ts
Service code: /lib/core/log.ts
Respective services(s): services_log

App Services (Informational)

Informational documentation about system services written for people to read. This information is dynamically compiled at application start time and includes the respective TypeScript interface definition for each defined service as well as an specified type reference.

Dashboard user interface code: /lib/dashboard/sections/services_app.ts
Service code: none
Respective services(s): none

FAQ (Informational)

Static information about connection, service details, and features managed by this application in a question and answer format.

Dashboard user interface code: none
Service code: none
Respective services(s): none

Help (Informational)

Generalized documentation about this application not covered in the feature specific documentation.

Dashboard user interface code: none
Service code: none
Respective services(s): none

Aphorio v0.6.3