consul-debug-read

a simple cli tool for parsing consul-debug bundles to readable format

Getting Started

Download latest release

linux|darwin architecture installs

bash <(curl -sSL https://raw.githubusercontent.com/natemollica-nm/consul-debug-read/main/scripts/download.sh)

If you're having issues running the above scripted installation, you can enable more verbose output by running with '1' flag:

bash <(curl -sSL https://raw.githubusercontent.com/natemollica-nm/consul-debug-read/main/scripts/download.sh) 1

Configuring consul-debug-read

This tool uses the contents from the extracted bundle path to deliver a more useful and readable interpretation of the bundle. The following sections explain how to point the tool to the right place using one of the three options:

Point to .tar.gz debug bundle to extract + set tool's location to the bundle's extracted root dir
Point to a previously extracted bundle's root dir
Set the CONSUL_DEBUG_READ environment variable and run the config set-path command

Run: consul-debug-read config [options]

Available Subcommands	Description
`set-path`	Configures CLI tool's extracted directory root of focus
`current-path`	Prints currently configured debug bundle extraction root of focus
`show`	Prints all current configuration settings applied

Available Options	Description
`-file`	File path to .tar.gz set for debug bundle reading analysis
`-path`	File path to set for debug bundle reading analysis - path to folder containing multiple consul-debug.tar.gz files - already extracted bundle root directory

Identify the .tar.gz filepath or previously extracted root directory location you wish to examine.
Configure the tool to use this bundle's extract path:

# Example of set-path to directory where exact name of bundle is unknown | Selecting Option `2`
$ consul-debug-read config set-path -path ~/Downloads

       Consul Debug Bundle Extraction Tool                                             
       -----------------------------------                                             
Option Bundle Name                                                                     Size     
1      124722consul-debug-2023-12-20T05-23-33Z.tar.gz                                  27.00 MB 
2      124722consul-debug-baseline-us-135-stag-default-2023-12-01T15-10-08-0500.tar.gz 45.05 MB 
3      139291consul-debug-1707327876.tar.gz                                            80.02 MB 
4      consul-debug-1698780735.tar.gz                                                  27.41 MB 
5      consul-debug-read_v0.0.2_darwin_arm64 (1).tar.gz                                3.54 MB  
6      consul-debug-read_v0.0.2_darwin_arm64.tar.gz                                    3.54 MB  
7      consul-debug-read_v0.0.2_linux_arm64.tar.gz                                     3.24 MB  

Enter the file option number to extract: 2

consul-debug-path set successfully => /Users/user/Downloads/consul-debug-2023-12-01T15-10-08-0500

Reading consul-debug-read configuration settings

$ consul-debug-read config show                                                                                                                                                                                                                                                               100%  
                            consul-debug-read configuration settings                                                         
                            ----------------------------------------                                                         
Setting                     Value                                                                                            
-------                     -----                                                                                            
Configuration File Location /Users/user/.consul-debug-read/config.yaml
Debug Bundle Path           /Users/user/HashiCorp/consul-debug-read/bundles/consul-debug-1707327876 (cli:-path|-file)
CONSUL_DEBUG_PATH           <UNSET>

Using environment variable

Note: the -path and -file flags override this setting if passed in

Export your terminal/shell session CONSUL_DEBUG_PATH variable:

$ export CONSUL_DEBUG_PATH=bundles/consul-debug-2023-10-04T18-29-47Z

$ consul-debug-read config set-path
  consul-debug-path set successfully using CONSUL_DEBUG_PATH env var => bundles/consul-debug-2024-02-07T12-40-42-0500

Usage

Extract (if applicable) and set debug directory path as outlined in configuring consul-debug-read section above.
Explore bundle return options using consul-debug-read -help

Consul Debug Overall Summary

Run: consul-debug-read summary

# Example summary return
Consul Debug Bundle (2024-02-07 13:33:52): bundles/consul-debug-2024-02-07T12-40-42-0500
Debug Command Log Level: TRACE (Default) 
  * bundles/consul-debug-2024-02-07T12-40-42-0500/consul.log (1.57 MB)

Agent Configuration Summary:
----------------------------
Version: 1.17.1+ent
Server: true
Raft State: Leader
WAN Federation Status: true
WAN Federation Method: Basic (WAN Gossip)
WAN Member Count: 29
WAN Datacenter Count: 5
Datacenter: us-42-prod-default
Primary DC: us-east-primary
NodeName: ip-10-137-45-113
Supported Envoy Versions: [1.28.0 1.27.2 1.26.6 1.25.11 1.24.12 1.23.12 1.22.11]

Metrics Bundle Summary
----------------------
Datacenter: us-42-prod-default
Hostname: ip-10-28-78-42.ec2.internal
Agent Version: 1.17.2+ent
Raft State: Leader
Interval: 30s
Duration: 5m2s
Capture Targets: [metrics logs host agent members]
Total Captures: 30
Capture Time Start: 2024-02-07 17:40:40 +0000 UTC
Capture Time Stop: 2024-02-07 17:45:30 +0000 UTC

Host Summary:
-------------
OS: linux
Hostname: ip-10-28-78-42.ec2.internal
Architecture: aarch64
CPU Cores: 8
CPU Vendor ID: ARM
CPU Model: 
Platform: alpine | 3.17.7
Running Since: 1706635334
Total Uptime: 8 days, 0 hours, 18 minutes, 29 seconds

Host Memory Metrics Summary:
----------------------------
Used: 2.68 GB  (8.76%)
Total Available: 27.58 GB
Total: 30.63 GB

Host Disk Metrics Summary:
--------------------------
Used: 11.79 GB  (42.33%)
Total Available: 16.06 GB
Total: 29.36 GB

Consul Log Parsing

Parse INFO, WARN, ERROR, DEBUG, and TRACE level log messages

Run: consul-debug-read log <subcommand> [options]

Available Subcommands	Description
`parse-info`	Returns all `[INFO]` messages
`parse-warn`	Returns all `[WARN]` messages
`parse-error`	Returns all `[ERROR]` messages
`parse-debug`	Returns all `[DEBUG]` messages
`parse-trace`	Returns all `[TRACE]` messages
`parse-rpc-counts`	Returns all `[TRACE]` messages pertaining to RPC rate limits in calls/minute

Available Options	Subcommand	Description
`-message-count`	`parse-[<log_level>]`	Parse log for specific-level messages and return count sorted (descending order) list of messages received
`-source-count`	`parse-[<log_level>]`	Parse log for specific-level messages and return count sorted (descending order) list of messages received from specific sources
`-source`	`parse-[<log_level>]`	Capture specific-level messages from specific sources (e.g., "agent.http","agent.server", etc)
`-method`	`parse-rpc-counts`	Specify a specific RPC method for filtering RPC count results (e.g., "Catalog.NodeServiceList", "Health.ServiceNodes")

# Example using parse-debug sub-command
$ consul-debug-read log parse-debug                                                                                                                                                                                                                                                                     100%  
Timestamp            Source                                        Message                                                                                                                                                                                                  
2024-02-07T17:55:07Z agent.http                                    Request finished: method=GET url=/v1/catalog/datacenters from=10.137.149.96:56628 latency="427.384µs"                                                                                                    
2024-02-07T17:55:07Z agent.router                                  server in area left, skipping: server=consul-server-02.us-east area=wan func=GetDatacentersByDistance                                                                                           
2024-02-07T17:55:07Z agent.router                                  server in area left, skipping: server=consul-server-05.us-east area=wan func=GetDatacentersByDistance                                                                                           
2024-02-07T17:55:07Z agent.router                                  server in area left, skipping: server=consul-server-01.us-east area=wan func=GetDatacentersByDistance                                                                                           
2024-02-07T17:55:07Z agent.router                                  server in area left, skipping: server=consul-server-03.us-east area=wan func=GetDatacentersByDistance                                                                                           
2024-02-07T17:55:07Z agent.router                                  server in area left, skipping: server=consul-server-04.us-east area=wan func=GetDatacentersByDistance                                                                                           
2024-02-07T17:55:07Z agent.http                                    Request finished: method=GET url=/v1/status/leader from=10.137.127.240:51352 latency="103.746µs"                                                                                                         
2024-02-07T17:55:06Z agent.http                                    Request finished: method=GET url=/v1/status/leader from=10.137.89.52:33060 latency="83.135µs"

# Example using parse-debug -message-count
$ consul-debug-read log parse-debug -message-count                                                                                                                                                                                                                                                      100%  
Timestamp        Counts Source                                        Message                                                                                                                                                                                           
2024-02-07 17:54 48     agent.router                                  server in area left, skipping: server=consul-server-02.us-east area=wan func=GetDatacentersByDistance                                                                                    
2024-02-07 17:51 48     agent.router                                  server in area left, skipping: server=consul-server-01.us-east area=wan func=GetDatacentersByDistance                                                                                    
2024-02-07 17:54 48     agent.router                                  server in area left, skipping: server=consul-server-05.us-east area=wan func=GetDatacentersByDistance                                                                                    
2024-02-07 17:51 48     agent.router                                  server in area left, skipping: server=consul-server-03.us-east area=wan func=GetDatacentersByDistance                                                                                    
2024-02-07 17:51 48     agent.router                                  server in area left, skipping: server=consul-server-04.us-east area=wan func=GetDatacentersByDistance                                                                                    
2024-02-07 17:54 48     agent.router                                  server in area left, skipping: server=consul-server-01.us-east area=wan func=GetDatacentersByDistance
2024-02-07 17:52 1      agent.grpc-api.server-discovery.watch-servers starting stream: request_id=0813831d-145d-cfb7-5c95-cef228ff1cc3                                                                                                                                  
2024-02-07 17:54 1      agent.http                                    Request finished: method=GET url=/v1/catalog/datacenters from=10.137.29.125:55184 latency="432.267µs"                                                                                             
2024-02-07 17:51 1      agent.http                                    Request finished: method=GET url="/v1/health/service/queue-consumer?dc=us-east&index=2446522905&passing=1&stale=&wait=60000ms" from=10.137.123.50:34598 latency=1m0.000417706s                    
2024-02-07 17:52 1      agent.http                                    Request finished: method=GET url=/v1/status/leader from=10.137.56.240:1213 latency="80.772µs"                                                                                                     
2024-02-07 17:53 1      agent.http                                    Request finished: method=GET url="/v1/health/service/queue-consumer?dc=us-137-prod-default&passing=1&stale=&wait=60000ms" from=10.137.154.62:38878 latency="151.353µs"                            
2024-02-07 17:54 1      agent.http                                    Request finished: method=GET url=/v1/status/leader from=10.137.127.240:38958 latency="89.814µs"                                                                                                   
2024-02-07 17:54 1      agent.http                                    Request finished: method=GET url=/v1/status/leader from=10.137.127.240:55117 latency="78.409µs"

Consul RPC Rate Limiting Method Calls/Minute

Run: consul-debug-read parse-rpc-counts

# Example rpc-counts return
$ consul-debug-read log parse-rpc-counts                                                                                                                                                                                                                                                                100%  
Method                  Minute-Interval  Counts 
Health.ServiceNodes     2024-02-07 17:50 443    
Status.RaftStats        2024-02-07 17:51 300    
Status.RaftStats        2024-02-07 17:52 300    
Status.RaftStats        2024-02-07 17:53 300    
Status.RaftStats        2024-02-07 17:54 300    
Health.ServiceNodes     2024-02-07 17:54 293    
Status.RaftStats        2024-02-07 17:50 270    
Health.ServiceNodes     2024-02-07 17:53 158    
Health.ServiceNodes     2024-02-07 17:52 140    
Health.ServiceNodes     2024-02-07 17:51 116    
Status.Leader           2024-02-07 17:54 64     
Status.Leader           2024-02-07 17:53 64     
Status.Leader           2024-02-07 17:52 64     
Status.Leader           2024-02-07 17:51 64     
Status.Leader           2024-02-07 17:50 58     
ConnectCA.Roots         2024-02-07 17:50 51     
Catalog.ListDatacenters 2024-02-07 17:53 46     
Catalog.ListDatacenters 2024-02-07 17:51 45     
Catalog.ListDatacenters 2024-02-07 17:54 44     
Catalog.ListDatacenters 2024-02-07 17:52 44     
Status.RaftStats        2024-02-07 17:55 40     
Catalog.ListDatacenters 2024-02-07 17:50 34     
Health.ServiceNodes     2024-02-07 17:55 25     
ConnectCA.Roots         2024-02-07 17:51 22     
PreparedQuery.Execute   2024-02-07 17:50 12

Consul Agent

Run: consul-debug-read agent <subcommand> [options]

Available Subcommands	Description
`summary`	Returns agent-specific information in summarized format
`config`	Returns HCL formatted agent configuration
`members`	Parses members.json and formats to typical 'consul members -wan' output
`raft-configuration`	Retrieve agent's latest raft configuration summary'

Consul Serf Membership

consul debug only runs a cached members scrape to the /v1/catalog/members?wan endpoint

Run: consul-debug-read agent members

# Example member return
Node                      Address             Status Type   Build      Protocol DC
consul-i-01582cee96cd7dc0d 10.34.24.112:8302   Alive  server 1.15.3+ent 2        eu-01-stag
consul-i-071c21a8d67edfe0d 10.34.23.73:8302    Alive  server 1.15.3+ent 2        eu-01-stag
consul-i-073d7d2439f2e180f 10.34.45.248:8302   Alive  server 1.15.3+ent 2        eu-01-stag
consul-i-0cc823f00596e8804 10.34.37.210:8302   Alive  server 1.15.3+ent 2        eu-01-stag
consul-i-0dd679e8a2f054ac1 10.34.12.122:8302   Alive  server 1.15.3+ent 2        eu-01-stag
ip-10-133-22-121          10.133.22.121:8302  Alive  server 1.15.6+ent 2        eu-133-stag-default
ip-10-133-45-202          10.133.45.202:8302  Alive  server 1.15.6+ent 2        eu-133-stag-default
ip-10-133-53-253          10.133.53.253:8302  Alive  server 1.15.6+ent 2        eu-133-stag-default
ip-10-133-92-59           10.133.92.59:8302   Alive  server 1.15.6+ent 2        eu-133-stag-default
ip-10-133-94-169          10.133.94.169:8302  Alive  server 1.15.6+ent 2        eu-133-stag-default
ip-10-135-120-205         10.135.120.205:8302 Alive  server 1.15.6+ent 2        us-135-stag-default
ip-10-135-134-71          10.135.134.71:8302  Alive  server 1.15.6+ent 2        us-135-stag-default
ip-10-135-25-56           10.135.25.56:8302   Alive  server 1.15.6+ent 2        us-135-stag-default
ip-10-135-37-187          10.135.37.187:8302  Alive  server 1.15.6+ent 2        us-135-stag-default
ip-10-135-78-52           10.135.78.52:8302   Alive  server 1.15.6+ent 2        us-135-stag-default

Consul Raft Configuration

Run: consul-debug-read agent raft-configuration

# Example raft configuration return
Node                      ID                                   Address           State    Voter AppliedIndex CommitIndex
consul-i-0aa97949095868769 666e152f-7316-81aa-848b-3f4719564404 10.2.101.211:8300 leader   true  2696106337   2696106337
consul-i-0ba0dff4180ec2dc7 4f36f7ab-240a-61a6-c5e1-b78ce62813a2 10.2.4.230:8300   follower true  -            -
consul-i-08e67d882fe525809 1baa8d56-a9ae-adf7-5309-b12460c3e6c5 10.2.64.253:8300  follower true  -            -
consul-i-05a474f75fea384bb 263fd5e5-fbd7-90b1-a904-4ab3c53b74f7 10.2.17.109:8300  follower true  -            -
consul-i-06033dd57876bf1a7 eca79896-dad9-1713-94a2-c2b35a37d7df 10.2.4.89:8300    follower true  -            -

Consul Agent Configuration

Convert agent.json Debug Configuration to readable user formatted agent configuration JSON file.

Run: consul-debug-read agent config

{
  "datacenter": "us-east-stag",
  "primary_datacenter": "us-east-stag",
  "node_name": "hashi-i-05a474f75fea384bb",
  "data_dir": "/data/consul/",
  "server": true,
  "addresses": {
    "dns": [
      "tcp://0.0.0.0:8600",
      "udp://0.0.0.0:8600"
    ],
    "http": [
      "tcp://0.0.0.0:8500"
    ],
    "grpc": [
      "tcp://0.0.0.0:8502"
    ],
    "grpc_tls": [
      "tcp://0.0.0.0:8503"
    ]
  },
  "bind_addr": "0.0.0.0",
  "client_addr": "0.0.0.0",
  "skip_leave_on_interrupt": false,
  "leave_on_terminate": false,
  "discovery_max_stale": "1s",
  "log_level": "INFO",
  "log_json": true,
  "ports": {
    "dns": 8600,
    "http": 8500,
    "https": -1,
    "serf_lan": 8301,
    "serf_wan": 8302,
    "server": 8300,
    "grpc": 8502,
    "grpc_tls": 8503,
    "sidecar_min_port": 21000,
    "sidecar_max_port": 21255,
    "expose_min_port": 21500,
    "expose_max_port": 21755
  },
  "acl": {
    "enabled": true,
    "enable_token_replication": true,
    "policy_ttl": "30s",
    "role_ttl": "0s",
    "token_ttl": "30s",
    "down_policy": "extend-cache",
    "default_policy": "allow",
    "tokens": {
      "initial_management": "hidden",
      "replication": "hidden",
      "agent_recovery": "hidden",
      "default": "hidden",
      "agent": "hidden",
      "config_file_service_registration": "hidden"
    },
    "enable_token_persistence": true
  },
  "auto_encrypt": {},
  "tls": {
    "defaults": {
      "key_file": "hidden",
      "tls_min_version": "TLSv1_2"
    },
    "grpc": {
      "key_file": "hidden",
      "tls_min_version": "TLSv1_2"
    },
    "https": {
      "key_file": "hidden",
      "tls_min_version": "TLSv1_2"
    },
    "internal_rpc": {
      "key_file": "hidden",
      "tls_min_version": "TLSv1_2"
    },
    "NodeName": "hashi-i-05a474f75fea384bb",
    "ServerMode": true
  },
  "enable_debug": true,
  "telemetry": {
    "dogstatsd_addr": "127.0.0.1:8125",
    "retry_failed_connection": true,
    "filter_default": true,
    "prefix_filter": [
      "consul.rpc.server.call"
    ],
    "metrics_prefix": "consul",
    "prometheus_retention_time": "0s"
  },
  "dns": {
    "allow_stale": true,
    "max_stale": "87600h0m0s",
    "node_ttl": "1m0s",
    "only_passing": true,
    "recursor_strategy": "sequential",
    "recursor_timeout": "2s",
    "service_ttl": {
      "*": "10s"
    },
    "udp_answer_limit": 3,
    "enable_additional_node_meta_txt": true,
    "soa": {
      "refresh": 3600,
      "retry": 600,
      "expire": 86400
    },
    "use_cache": false,
    "cache_max_age": "0s"
  },
  "cache": {
    "entry_fetch_max_burst": 2,
    "entry_fetch_rate": 1.7976931348623157e+308
  },
  "limits": {
    "request_limits": {}
  },
  "xds": {
    "update_max_per_second": 250
  }
}

Consul Metrics Summary

Run: consul-debug-read metrics -summary

# Example metrics summary overview return
Metrics Bundle Summary: bundles/consul-debug-2023-10-04T18-29-47Z/metrics.json
----------------------
Host Name: ip-10-135-37-187.ec2.internal
Agent Version: 1.15.6+ent
Raft State: Leader
Interval: 30s
Duration: 5m2s
Capture Targets: [metrics logs host agent members]
Total Captures: 30
Capture Time Start: 2023-10-23 15:03:40 +0000 UTC
Capture Time Stop: 2023-10-23 15:08:30 +0000 UTC

Consul Metrics by Type

consul-debug-read comes with prebuilt variable groupings for each key-metric data type to aid in quickly assessing more important metrics to the scenario

Command Option	Description
`-auto-pilot`	Retrieve key autopilot related metric values
`-bolt-db`	Retrieve key boltDB related metric values for Consul from debug bundle
`-dataplane-health`	Retrieve key dataplane-related metric values for Consul from debug bundle
`-federation-health`	Retrieve key secondary datacenter federation metric values for Consul from debug bundle
`-host`	Retrieve Host specific metrics
`-key-metrics`	Retrieve key metric values for Consul from debug bundle
`-leadership-health`	Retrieve key raft leadership stability metric values for Consul from debug bundle
`-list-available-telemetry`	List available metric names as retrieved from consul telemetry docs
`-memory`	Retrieve key memory metric values for Consul from debug bundle
`-name=<string>`	Retrieve specific metric timestamped values by name
`-network`	Retrieve key network metric values for Consul from debug bundle
`-raft-thread-health`	Retrieve key raft thread saturation metric values for Consul from debug bundle
`-rate-limiting`	Retrieve key rate limit metric values for Consul from debug bundle
`-transaction-timing`	Retrieve key transaction timing metric values for Consul from debug bundle

# Example using -memory flag
$ consul-debug-read metrics -memory

                              consul.runtime.alloc_bytes 
                              -------------------------- 
Timestamp                     Metric                     Type  Unit  Value    
2024-02-07 17:44:40 +0000 UTC consul.runtime.alloc_bytes gauge bytes 55.17 MB 
2024-02-07 17:44:50 +0000 UTC consul.runtime.alloc_bytes gauge bytes 35.74 MB 
2024-02-07 17:45:00 +0000 UTC consul.runtime.alloc_bytes gauge bytes 45.64 MB 
2024-02-07 17:45:10 +0000 UTC consul.runtime.alloc_bytes gauge bytes 55.04 MB 
2024-02-07 17:45:20 +0000 UTC consul.runtime.alloc_bytes gauge bytes 65.78 MB 
2024-02-07 17:45:30 +0000 UTC consul.runtime.alloc_bytes gauge bytes 41.88 MB 

                              consul.runtime.heap_objects 
                              --------------------------- 
Timestamp                     Metric                      Type  Unit              Value  
2024-02-07 17:44:40 +0000 UTC consul.runtime.heap_objects gauge number of objects 365517 
2024-02-07 17:44:50 +0000 UTC consul.runtime.heap_objects gauge number of objects 162247 
2024-02-07 17:45:00 +0000 UTC consul.runtime.heap_objects gauge number of objects 252355 
2024-02-07 17:45:10 +0000 UTC consul.runtime.heap_objects gauge number of objects 341498 
2024-02-07 17:45:20 +0000 UTC consul.runtime.heap_objects gauge number of objects 434737 
2024-02-07 17:45:30 +0000 UTC consul.runtime.heap_objects gauge number of objects 217709 
                                                     
                                                  
                              consul.runtime.sys_bytes 
                              ------------------------ 
Timestamp                     Metric                   Type  Unit  Value     
2024-02-07 17:44:40 +0000 UTC consul.runtime.sys_bytes gauge bytes 191.30 MB 
2024-02-07 17:44:50 +0000 UTC consul.runtime.sys_bytes gauge bytes 191.30 MB 
2024-02-07 17:45:00 +0000 UTC consul.runtime.sys_bytes gauge bytes 191.30 MB 
2024-02-07 17:45:10 +0000 UTC consul.runtime.sys_bytes gauge bytes 191.30 MB 
2024-02-07 17:45:20 +0000 UTC consul.runtime.sys_bytes gauge bytes 191.30 MB 
2024-02-07 17:45:30 +0000 UTC consul.runtime.sys_bytes gauge bytes 191.30 MB 

                                                          
                              consul.runtime.total_gc_pause_ns 
                              -------------------------------- 
Timestamp                     Metric                           Type  Unit Value gc/min       
2024-02-07 17:44:40 +0000 UTC consul.runtime.total_gc_pause_ns gauge ns   1.77s -            
2024-02-07 17:44:50 +0000 UTC consul.runtime.total_gc_pause_ns gauge ns   1.77s 1.18ms/min   
2024-02-07 17:45:00 +0000 UTC consul.runtime.total_gc_pause_ns gauge ns   1.77s 0.0000ns/min 
2024-02-07 17:45:10 +0000 UTC consul.runtime.total_gc_pause_ns gauge ns   1.77s 0.0000ns/min 
2024-02-07 17:45:20 +0000 UTC consul.runtime.total_gc_pause_ns gauge ns   1.77s 0.0000ns/min 
2024-02-07 17:45:30 +0000 UTC consul.runtime.total_gc_pause_ns gauge ns   1.77s 1.01ms/min

Consul Metrics by Name

Run: consul-debug-read metrics -name consul.runtime.sys_bytes

# Example return
                              consul.runtime.sys_bytes           
                              ------------------------           
Timestamp                     Metric                             Type  Unit  Value    
2023-10-23 15:03:40 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:03:50 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:04:00 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:04:10 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:04:20 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:04:30 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:04:40 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:04:50 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:05:00 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:05:10 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:05:20 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:05:30 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:05:40 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:05:50 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:06:00 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:06:10 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:06:20 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:06:30 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:06:40 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:06:50 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:07:00 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:07:10 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:07:20 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:07:30 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:07:40 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:07:50 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:08:00 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:08:10 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:08:20 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB 
2023-10-23 15:08:30 +0000 UTC consul.runtime.sys_bytes.sys_bytes gauge bytes 16.25 GB

Consul Host Metrics

Run: consul-debug-read metrics -host

#Example Host Specific Metrics
Host Metrics Summary: bundles/consul-debug-2023-10-23T11-03-40-0400/host.json
----------------------
OS: linux
Host Name consul-i-0aa97949095868769.node.consul
Architecture: x86_64
Number of Cores: 36
CPU Vendor ID: GenuineIntel
CPU Model Name: Intel(R) Xeon(R) Platinum 8124M CPU @ 3.00GHz
Platform: ubuntu | 20.04
Running Since: 2023-10-13 11:33:49 PDT
Uptime at Capture: 9 days, 20 hours, 29 minutes, 52 seconds

Host Memory Metrics Summary:
----------------------
Used: 15.92 GB  (23.21%)
Total Available: 51.75 GB
Total: 68.57 GB

Host Disk Metrics Summary:
----------------------
Used: 5.96 GB  (3.08%)
Free: 187.67 GB
Total: 193.65 GB

Building and installing locally with Go

Install golang

Follow the Download and Installation Instructions for installing go for your platform.

Setup your GOPATH and GOROOT (if applicable) appropriately

If using macbook and installing go with homebrew set GOPATH and GOROOT as outlined in the examples below.

GOPATH is discussed in the Cmd/go documentation:

The GOPATH environment variable lists places to look for Go code. On Unix, the value is a colon-separated string. On Windows, the value is a semicolon-separated string. On Plan 9, the value is a list. GOPATH must be set to get, build and install packages outside the standard Go tree.

export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin

GOROOT is discussed in the installation instructions:

The Go binary distributions assume they will be installed in /usr/local/go (or c:\Go under Windows), but it is possible to install the Go tools to a different location. In this case you must set the GOROOT environment variable to point to the directory in which it was installed. For example, if you installed Go to your home directory you should add the following commands to $HOME/.profile:

# Example setting GOROOT with homebrew go installation.
export GOROOT=/opt/homebrew/opt/go/libexec
export PATH=$PATH:$GOROOT/bin

Note: GOROOT must be set only when installing to a custom location.

Clone this repository: $ git clone https://github.com/natemollica-nm/consul-debug-read.git
Change to repo directory: $ cd consul-debug-read
Build and install binary: $ go install
Test binary installed in path: $ consul-debug-read -help

Name		Name	Last commit message	Last commit date
Latest commit History 140 Commits
.github		.github
cmd		cmd
docs		docs
internal/read		internal/read
metrics		metrics
scripts		scripts
.gitignore		.gitignore
.goreleaser.yml		.goreleaser.yml
.tool-versions		.tool-versions
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
go.mod		go.mod
go.sum		go.sum
main.go		main.go
shell		shell

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

consul-debug-read

Table of Contents

Getting Started

Download latest release

Configuring consul-debug-read

Reading consul-debug-read configuration settings

Using environment variable

Usage

Consul Debug Overall Summary

Consul Log Parsing

Consul RPC Rate Limiting Method Calls/Minute

Consul Agent

Consul Serf Membership

Consul Raft Configuration

Consul Agent Configuration

Consul Metrics Summary

Consul Metrics by Type

Consul Metrics by Name

Consul Host Metrics

Building and installing locally with Go

About

Releases 12

Packages

Contributors 2

Languages

License

natemollica-nm/consul-debug-read

Folders and files

Latest commit

History

Repository files navigation

consul-debug-read

Table of Contents

Getting Started

Download latest release

Configuring consul-debug-read

Reading consul-debug-read configuration settings

Using environment variable

Usage

Consul Debug Overall Summary

Consul Log Parsing

Consul RPC Rate Limiting Method Calls/Minute

Consul Agent

Consul Serf Membership

Consul Raft Configuration

Consul Agent Configuration

Consul Metrics Summary

Consul Metrics by Type

Consul Metrics by Name

Consul Host Metrics

Building and installing locally with Go

About

Resources

License

Stars

Watchers

Forks

Releases 12

Packages 0

Contributors 2

Languages

Packages