Monitoring tenant activity

All client activity is associated with a tenant account. You can use the Grid Manager to monitor a tenant's storage usage or network traffic, or you can use the audit log or Grafana dashboards to gather more detailed information about how tenants are using StorageGRID.

Before you begin

About this task

Attention: The storage values and quotas displayed are estimates. These estimates are affected by the timing of ingests, network connectivity, and node status.
Attention: Quotas are based on estimated storage usage and might be exceeded in some cases. For example, StorageGRID checks the quota when a tenant starts uploading objects and rejects new ingests if the tenant has exceeded the quota. However, StorageGRID does not take into account the size of the current upload when determining if the quota has been exceeded.

Procedure

  1. Review the amount of storage used by a tenant:
    1. Select Tenants.
      The Tenant Accounts page appears.

      Tenant Accounts page
    2. Select the tenant whose usage you want to display, then click Usage.
      The Storage Usage panel appears.
      Tenant usage modal
      If a storage quota was specified for the tenant, the panel shows both the total amount of storage used and the amount of the quota that has been consumed.
  2. If traffic classification policies are in place for a tenant, review the network traffic for that tenant.
    1. Select Configuration. Then, in the System Settings section of the menu, select Traffic Classification.
      The Traffic Classification Policies page appears, and the existing policies are listed in the table.

      Traffic Policy for Graph Example
    2. Review the list of policies to identify the ones that apply to a specific tenant.
    3. To view metrics associated with a policy, select the radio button to the left of the policy, and then click Metrics.
    4. Analyze the graphs to determine how often the policy is limiting traffic and whether you need to adjust the policy.

      To create, edit, or delete traffic classification policies, see the instructions for administering StorageGRID.

  3. Optionally, use the audit log for more granular monitoring of a tenant's activities.
    For instance, you can monitor the following types of information:
    • Specific client operations, such as PUT, GET, or DELETE
    • Object sizes
    • The ILM rule applied to objects
    • The source IP of client requests
    Audit logs are written to text files that you can analyze using your choice of log analysis tool. This allows you to better understand client activities, or to implement sophisticated chargeback and billing models.

    See the instructions for understanding audit messages for more information.

  4. Optionally, use Prometheus metrics to report on tenant activity:
    • In the Grid Manager, select Support. Then, in the Tools section of the menu, select Metrics. You can use existing dashboards, such as S3 Overview, to review client activities.
      Attention: The tools available on the Metrics page are primarily intended for use by technical support. Some features and menu items within these tools are intentionally non-functional.
    • Select Help > API Documentation. You can use the metrics in the Metrics section of the Grid Management API to create custom alert rules and dashboards for tenant activity.