github.com/netdata/go.d.plugin@v0.58.1/modules/logind/integrations/systemd-logind_users.md (about)

     1  <!--startmeta
     2  custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/logind/README.md"
     3  meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/logind/metadata.yaml"
     4  sidebar_label: "systemd-logind users"
     5  learn_status: "Published"
     6  learn_rel_path: "Data Collection/Systemd"
     7  most_popular: False
     8  message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
     9  endmeta-->
    10  
    11  # systemd-logind users
    12  
    13  
    14  <img src="https://netdata.cloud/img/users.svg" width="150"/>
    15  
    16  
    17  Plugin: go.d.plugin
    18  Module: logind
    19  
    20  <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
    21  
    22  ## Overview
    23  
    24  This collector monitors number of sessions and users as reported by the `org.freedesktop.login1` DBus API.
    25  
    26  
    27  
    28  
    29  This collector is supported on all platforms.
    30  
    31  This collector supports collecting metrics from multiple instances of this integration, including remote instances.
    32  
    33  
    34  ### Default Behavior
    35  
    36  #### Auto-Detection
    37  
    38  This integration doesn't support auto-detection.
    39  
    40  #### Limits
    41  
    42  The default configuration for this integration does not impose any limits on data collection.
    43  
    44  #### Performance Impact
    45  
    46  The default configuration for this integration is not expected to impose a significant performance impact on the system.
    47  
    48  
    49  ## Metrics
    50  
    51  Metrics grouped by *scope*.
    52  
    53  The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
    54  
    55  
    56  
    57  ### Per systemd-logind users instance
    58  
    59  These metrics refer to the entire monitored application.
    60  
    61  This scope has no labels.
    62  
    63  Metrics:
    64  
    65  | Metric | Dimensions | Unit |
    66  |:------|:----------|:----|
    67  | logind.sessions | remote, local | sessions |
    68  | logind.sessions_type | console, graphical, other | sessions |
    69  | logind.sessions_state | online, closing, active | sessions |
    70  | logind.users_state | offline, closing, online, lingering, active | users |
    71  
    72  
    73  
    74  ## Alerts
    75  
    76  There are no alerts configured by default for this integration.
    77  
    78  
    79  ## Setup
    80  
    81  ### Prerequisites
    82  
    83  No action required.
    84  
    85  ### Configuration
    86  
    87  #### File
    88  
    89  The configuration file name for this integration is `go.d/logind.conf`.
    90  
    91  
    92  You can edit the configuration file using the `edit-config` script from the
    93  Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory).
    94  
    95  ```bash
    96  cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
    97  sudo ./edit-config go.d/logind.conf
    98  ```
    99  #### Options
   100  
   101  The following options can be defined globally: update_every, autodetection_retry.
   102  
   103  
   104  #### Examples
   105  There are no configuration examples.
   106  
   107  
   108  
   109  ## Troubleshooting
   110  
   111  ### Debug Mode
   112  
   113  To troubleshoot issues with the `logind` collector, run the `go.d.plugin` with the debug option enabled. The output
   114  should give you clues as to why the collector isn't working.
   115  
   116  - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
   117    your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
   118  
   119    ```bash
   120    cd /usr/libexec/netdata/plugins.d/
   121    ```
   122  
   123  - Switch to the `netdata` user.
   124  
   125    ```bash
   126    sudo -u netdata -s
   127    ```
   128  
   129  - Run the `go.d.plugin` to debug the collector:
   130  
   131    ```bash
   132    ./go.d.plugin -d -m logind
   133    ```
   134  
   135