Merge pull request #128 from zhongwencool/fix-typo

v1.8.6

Author: zhongwencool

.github/workflows/erlang.yml

@@ -26,3 +26,14 @@ jobs:
           rebar3-version: ${{matrix.rebar3}}
       - name: quality checks
         run: rebar3 check
+      - name: test coverage
+        run: |
+          epmd -daemon
+          rebar3 as test do eunit, covertool generate
+      - name: Upload coverage reports to Codecov
+        if: matrix.otp == '28'
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: zhongwencool/observer_cli
+          files: _build/test/covertool/*.covertool.xml

.gitignore

@@ -18,3 +18,4 @@ log/
 .erlang.mk
 
 xrefr
+AGENTS.md

README.md

@@ -3,13 +3,14 @@
 # observer_cli
 
 [![Build Status](https://github.com/zhongwencool/observer_cli/workflows/ci/badge.svg)](https://github.com/zhongwencool/observer_cli/actions)
+[![codecov](https://codecov.io/gh/zhongwencool/observer_cli/branch/main/graph/badge.svg)](https://codecov.io/gh/zhongwencool/observer_cli)
 [![GitHub tag](https://img.shields.io/github/tag/zhongwencool/observer_cli.svg)](https://github.com/zhongwencool/observer_cli)
 [![MIT License](https://img.shields.io/hexpm/l/observer_cli.svg)](https://hex.pm/packages/observer_cli)
 [![Hex.pm Version](https://img.shields.io/hexpm/v/observer_cli.svg)](https://hex.pm/packages/observer_cli)
 [![Hex.pm Downloads](https://img.shields.io/hexpm/dt/observer_cli.svg)](https://hex.pm/packages/observer_cli)
 [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/observer_cli/)
 
-Observer CLI is a library to be dropped into any beam nodes, to be used to assist DevOps  people diagnose problems in production nodes. Based on [recon](https://github.com/ferd/recon).
+Observer CLI is a library to be dropped into any BEAM nodes, to be used to help DevOps people diagnose problems in production nodes. Based on [recon](https://github.com/ferd/recon).
 
 <img src="https://github.com/zhongwencool/observer_cli/raw/main/docs/images/home.png" width="100%" alt="Home"> </img>
 
@@ -28,7 +29,7 @@ Observer CLI is a library to be dropped into any beam nodes, to be used to assis
 %% rebar.config
 {deps, [observer_cli]}
 %% erlang.mk
-dep_observer_cli = hex 1.8.5
+dep_observer_cli = hex 1.8.6
 ```
 
 ### Elixir
@@ -53,6 +54,7 @@ dep_observer_cli = hex 1.8.5
 rebar3 shell
 1> observer_cli:start().
 ```
+Tip: CI uses `rebar3 as ci compile` (warnings are treated as errors).
 ### Elixir
 ```elixir
 %% mix project
@@ -79,7 +81,7 @@ iex(1)> :observer_cli.start(:'target@host', :'magic_cookie')
 <!-- tabs-close -->
 
 > #### exclamation {: .info}
-> **ensure observer_cli application been loaded on target node.**
+> **ensure the observer_cli application has been loaded on the target node.**
 
 > #### tip {: .tip}
 > Pass `{interval, 3000}` (Erlang) or `interval: 3000` (Elixir) to sample every 3 seconds. The minimum refresh interval is 1000 ms.
@@ -100,7 +102,7 @@ iex(1)> :observer_cli.start(:'target@host', :'magic_cookie')
 
 The Home panel provides a comprehensive overview of your Erlang node:
 
-[`erlang:system_info/1`](http://erlang.org/doc/man/erlang.html#system_info-1) returns specified information about the current system by below item. When the ratio is greater than 85%, it becomes red.
+[`erlang:system_info/1`](http://erlang.org/doc/man/erlang.html#system_info-1) returns specified information about the current system in the items below. When the ratio is greater than 85%, it becomes red.
 
 | Metric             | Source/Limit              |
 |--------------------|---------------------------|
@@ -109,7 +111,7 @@ The Home panel provides a comprehensive overview of your Erlang node:
 | Atom Count         | atom_count/atom_limit     |
 
 * **process_limit**: `erl +P Number` sets the maximum number of simultaneously existing processes for this system if a Number is passed as value. Valid range for Number is [1024-134217727]. The default value is 262144.
-* **port_limit**: `erl +Q Number` sets the maximum number of simultaneously existing ports for this system if a Number is passed as value. Valid range for Number is [1024-134217727]. The default value used is normally 65536. However, if the runtime system is able to determine maximum amount of file descriptors that it is allowed to open and this value is larger than 65536, the chosen value will increased to a value larger or equal to the maximum amount of file descriptors that can be opened.
+* **port_limit**: `erl +Q Number` sets the maximum number of simultaneously existing ports for this system if a Number is passed as value. Valid range for Number is [1024-134217727]. The default value used is normally 65536. However, if the runtime system is able to determine maximum amount of file descriptors that it is allowed to open and this value is larger than 65536, the chosen value will be increased to a value larger than or equal to the maximum amount of file descriptors that can be opened.
 * **atom_limit**: `erl +t size` sets the maximum number of atoms the virtual machine can handle. Defaults to 1,048,576.
 
 [`ps`](https://man7.org/linux/man-pages/man1/ps.1.html) reports a snapshot of the BEAM OS process and feeds the system panel. Observer CLI samples four columns:
@@ -155,7 +157,7 @@ When looking for high memory usage, for example it's interesting to be able to l
 
 [`recon:proc_count/2`](http://ferd.github.io/recon/recon.html#proc_count-2) and [`recon:proc_window/3`](http://ferd.github.io/recon/recon.html#proc_window-3) are to be used when you require information about processes in a larger sense: biggest consumers of given process `memory`, `reductions`, `binary`, `total_heap_size`, `message_queue_len`, either absolutely or over a sliding time window, respectively.
 
-More detail about sliding time windows see [`recon:proc_window/3`](http://ferd.github.io/recon/recon.html#proc_window-3)
+For more detail about sliding time windows, see [`recon:proc_window/3`](http://ferd.github.io/recon/recon.html#proc_window-3)
 
 When an abnormal process is found, enter the suspected process sequence(Integer) then press `Enter` will use [`erlang:process_info/2`](http://erlang.org/doc/man/erlang.html#process_info-2) to show a lot of information available (which is safe to use in production) about processes.
 

docs/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Changelog
+- 1.8.6
+  - Add external formatter support (dynamic loading/app env) and docs; formatter callback now receives pid.
+  - Improve State view rendering by fixing redraw timers and infinite-loop edge cases.
+  - Improve less_client/less_server navigation and status output (F/B commands, last line, row fetching).
+  - Auto update net_ticktime.
+  - Fix mix compilation and avoid compiling test/ in release builds.
+  - Remove recon from included_applications.
+
+- 1.8.5
+  - Sync default env between mix.exs and .app.src; comment out scheduler_usage default.
+  - Refactor app stats and command parsing internals; update type specs and configs.
+  - Update docs and plugin guide; refresh README images/assets.
+  - CI: drop OTP 24/25 from test matrix.
+
 - 1.8.4
-  - Fix OTP 28 dialzyer warning.
+  - Fix OTP 28 dialyzer warning.
   - Use erlang:processes_iterator/0, erlang:process_next/1 to fold processes when OTP 28.
 
 - 1.8.3
@@ -17,36 +31,36 @@
 - 1.8.0
   - Support `<Pid` to jump to specific pid.
   - Show process's label if it's set with [proc_lib:set_label(Label)](https://www.erlang.org/doc/apps/stdlib/proc_lib.html#set_label/1)
-  - Show The number of bytes in the output distribution queue on System View. This queue sits between the Erlang code and the port driver, using undocumented function`erlang:dist_get_stat/1`.
-  - Fix Doc View not show when otp version = 27
+  - Show the number of bytes in the output distribution queue on System View. This queue sits between the Erlang code and the port driver, using undocumented function `erlang:dist_get_stat/1`.
+  - Fix Doc View not showing when OTP version = 27
 
 - 1.7.5
   - Fix crash when mnesia table with external copies.
     Which `mnesia:table_info(TabName, storage_type)` returns tuple `{ext, _, _}`
   - Correct the order of the application information; the items Memory and Reductions have been switched.
 
 - 1.7.4
-  - fix crash when ets:info/1 return undefined.
+  - fix crash when ets:info/1 returns undefined.
 - 1.7.3
   - fix system pane exception by `ps` command.
 - 1.7.2
   - Fix error when inspecting process that monitors via {RegName, Node}.
 - 1.7.1
-  - application view show starting/loading/startPfalse/loaded/started application.
-  - fixed badarg when staring by rpc and stop by `ctrl+c`.
-  - fixed mix.exe version error
+  - application view shows starting/loading/start_p_false/loaded/started application.
+  - fixed badarg when starting by RPC and stopping with `ctrl+c`.
+  - fixed mix.exs version error
 - 1.7.0
   - application view support reductions/memory/process_count sort
   - plugin support `{byte, 1024}` to `10.0000 KB`
-  - plugin support `{percent, 0.1234` to `12.34%`
+  - plugin support `{percent, 0.1234}` to `12.34%`
   - plugin support dig deep process view.
 - 1.6.2
-  - fixed crash when ps command not found on windows.
+  - fixed crash when ps command not found on Windows.
 - 1.6.1
-  - remove precise opt version
+  - remove precise OTP version
 - 1.6.0
-  - hidden schedule usage default
-  - format by erlformat
+  - hidden scheduler usage default
+  - format with erlfmt
   - add `ps -o pcpu,pmem,rss,vsz` information
   - remove recon_alloc:memory/1 from `HOME`(too much cpu usage)
 - 1.5.4
@@ -60,44 +74,44 @@
   - Bump Recon to 2.5.0
 - 1.4.5
   - Include a minimal mix.exs build file
-  - Make sure EXIT message has been clear
+  - Make sure EXIT message has been cleared
 - 1.4.4
   - Make sure connection errors can be handled
 - 1.4.3
   - Bump Recon to 2.4.0
 - 1.4.2
-  - Hidden schedule process bar when core > 100.
+  - Hidden scheduler process bar when core > 100.
   - Allow to compile escript w/ inet6 based distribution.
   - Rewrite plugin callback, rename kv_label/0 to attributes/1.
 - 1.4.1
   - Fixed ets view memory usage wrong.
-  - mnesia view memory usage According to bytes.
+  - mnesia view memory usage according to bytes.
 - 1.4.0
-  - Support write your own plugin.
+  - Support writing your own plugin.
 - 1.3.4
   - View(ets mnesia) support page down/up; support sort by memory or size.
   - Fixed pause crash.
   - Make refresh interval configurable.
 - 1.3.3
-  - fixed io:format(Format,Args) Format not support iolist OTP R21
+  - fixed io:format(Format, Args) does not support iolist in OTP R21
 - 1.3.2
-  - Make sure all observer_cli process exit when quit.
+  - Make sure all observer_cli processes exit when quit.
   - Upgrade recon to 2.3.6
 - 1.3.1
   - Add atom limit/count in home.
   - Escript support short name and long name.
-  - Fixed store process not exit.
+  - Fixed store process not exiting.
   - [Upgrade recon to 2.3.5](https://github.com/ferd/recon/commit/e0c3614334589e375f8b1492f404e4b764fe35e7)
 - 1.3.0
   - Rewrite Network/Process view.
   - Support PageDown/PageUp for top n list.
-  - Escript auto load observer_cli when it's not load on target node.
+  - Escript auto-loads observer_cli when it's not loaded on target node.
 - 1.2.2
-  - fix schedule number >= 32 display wrong.
+  - fix scheduler number >= 32 displayed incorrectly.
   - improve memory(byte/kilobyte/megabyte/gigabyte) unit.
 - 1.2.1
-  - fixed autosize not work.
-  - try best to make color adjust all platform.
+  - fixed autosize not working.
+  - try our best to make color adjust on all platforms.
 - 1.2.0
 
   - add application GUI.

docs/formatter.md

@@ -1,8 +1,8 @@
-# How use your own formatter?
+# How to use your own formatter?
 
 Observer CLI before rendering does formatting for:
 
-* Proccess State;
+* Process State;
 * Process Messages;
 * Process Dictionary.
 
@@ -26,9 +26,78 @@ Default formatter config:
 {formatter, #{application => observer_cli, mod => observer_cli_formatter_default}}
 ```
 
+Example: build an erlfmt formatter plugin (external)
+
+Goal: keep observer_cli clean, but let users plug in erlfmt.
+
+Step 1: create your own app
+
+Create a new Erlang app, for example `my_formatter_app`.
+
+Step 2: add erlfmt dependency in your app
+
+In your app's `rebar.config`:
+
+```erlang
+{deps, [
+    observer_cli,
+    erlfmt
+]}.
+```
+
+`observer_cli` is only for the behaviour check at compile time.
+
+Step 3: implement the behaviour
+
+Create a module in your app, for example `my_formatter_erlfmt`:
+
+```erlang
+-module(my_formatter_erlfmt).
+
+-behaviour(observer_cli_formatter).
+
+-export([format/2]).
+
+format(Pid, Term) ->
+    Header = io_lib:format("Process: ~p~n~n", [Pid]),
+    TermString = unicode:characters_to_list(io_lib:format("~p.~n", [Term])),
+    Formatted =
+        case erlfmt:format_string(TermString, []) of
+            {ok, Output, _Warnings} -> Output;
+            {skip, Output} -> Output;
+            {error, Error} -> erlang:error({erlfmt_format_failed, Error})
+        end,
+    [_ | _] = unicode:characters_to_list([Header, Formatted]).
+```
+
+Step 4: make sure the formatter app is on the target node
+
+The target node must have `my_formatter_app` available in its release,
+otherwise the formatter module cannot be loaded remotely.
+
+Step 5: tell observer_cli to use your formatter
+
+In the target node's `sys.config` (or runtime env):
+
+```erlang
+{observer_cli, [
+    {formatter, #{application => my_formatter_app, mod => my_formatter_erlfmt}}
+]}.
+```
+
+If your formatter crashes, observer_cli will fall back to the default formatter.
+
+Runtime env example:
+
+```erlang
+application:set_env(observer_cli, formatter, #{
+    application => my_formatter_app,
+    mod => my_formatter_erlfmt
+}).
+```
+
 **Option reference**
 
-- `application` - Formatter application. Observer CLI loads all it's modules to
+- `application` - Formatter application. Observer CLI loads all its modules to
   remote node.
 - `mod` - Implementation of observer_cli_formatter behaviour.
-

include/observer_cli.hrl

@@ -117,3 +117,5 @@
 -define('render'(_FA_), observer_cli_lib:render(_FA_)).
 -define('output'(_F_, _A_), io:format(iolist_to_binary(_F_), _A_)).
 -define('output'(_L_), ?output(_L_, [])).
+
+-define(DEFAULT_FORMATTER, #{application => observer_cli, mod => observer_cli_formatter_default}).

mix.exs

@@ -4,7 +4,7 @@ defmodule ObserverCli.MixProject do
   def project do
     [
       app: :observer_cli,
-      version: "1.8.5",
+      version: "1.8.6",
       language: :erlang,
       description: "observer in shell",
       deps: [
@@ -19,8 +19,7 @@ defmodule ObserverCli.MixProject do
         # {:formatter, #{
         # :application => atom(), - Formatter application. observer_cli loads all it's modules to remote node.
         # :mod => module() - observer_cli_formatter implementation.
-        # }}
-        formatter: %{application: :observer_cli, mod: :observer_cli_formatter_default},
+        # }},
         # scheduler_usage: :enable, # default value is 'disable', uncomment to enable by default
         plugins: [
           # module       - Specific module implements plugin behavior. It's mandatory.

rebar.config

@@ -16,13 +16,13 @@
     warn_untyped_record,
     debug_info
 ]}.
-{deps_dir, "deps"}.
 {deps, [
     recon
 ]}.
 
 {project_plugins, [
     erlfmt,
+    covertool,
     rebar3_lint,
     rebar3_ex_doc
 ]}.
@@ -47,11 +47,21 @@
 ]}.
 {xref_checks, [undefined_function_calls]}.
 {cover_enabled, true}.
+{cover_opts, [verbose]}.
+{cover_print_enabled, true}.
+{cover_export_enabled, true}.
+{covertool, [{coverdata_files, ["eunit.coverdata", "proper.coverdata", "ct.coverdata"]}]}.
 
 {profiles, [
+    {test, [
+        {erl_opts, [nowarn_missing_spec]}
+    ]},
     {inet6, [
         {escript_emu_args,
             "%%! -escript main observer_cli_escriptize -hidden -proto_dist inet6_tcp +sbtu +A0 -elixir ansi_enabled true\n"}
+    ]},
+    {ci, [
+        {erl_opts, [warn_as_error]}
     ]}
 ]}.