Registry / observability / r7insight-python

r7insight-python

library1.0.1pypypi✓ verified 87d ago

r7insight-python is a plugin library designed to integrate Python's standard logging module with Rapid7 Insight (formerly InsightOps). It enables sending log messages, and optionally method execution times, CPU, and memory statistics to your Rapid7 Insight account. The library leverages asynchronous operations for log dispatch and is currently at version 1.0.1. Releases appear to be infrequent, suggesting a mature or maintenance phase.

observability communication

pip install r7insight_python

package ↗homepage ↗

INSTALL

IMPORT

SIG · R7INSIGHT-PYTHON

r7insight-python

observabilitypythonv1.0.1

Install

1.8s avg

Import

94ms

Disk

16MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.920 runs

installs and imports cleanly · install 0.0s · import 0.098s · 18.1MB

glibc

py 3.10–3.920 runs

installs and imports cleanly · install 1.8s · import 0.090s · 19MB

16MB installed

● package 16MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

R7InsightHandler

✓ from r7insight import R7InsightHandler

metrics

✓ from r7insight import metrics

Used for the @metrics.Metric() decorator

This quickstart demonstrates basic logging to Rapid7 Insight. You need to obtain a Token UUID from a 'Token TCP' log source in your Rapid7 Insight account and specify your region. The example retrieves these values from environment variables or uses placeholders.

import logging import os from r7insight import R7InsightHandler # Get Rapid7 Insight Token and Region from environment variables # Ensure you configure a 'Token TCP' log source in your Rapid7 Insight account. TOKEN = os.environ.get('R7INSIGHT_TOKEN', 'YOUR_RAPID7_TOKEN') REGION = os.environ.get('R7INSIGHT_REGION', 'us') # e.g., 'us', 'eu', 'ca', 'au', 'jp', 'in', 'uk' # Basic logging setup log = logging.getLogger('r7insight') log.setLevel(logging.INFO) try: handler = R7InsightHandler(TOKEN, REGION) log.addHandler(handler) log.info("Hello from r7insight-python!") log.warning("This is a warning message.") log.error("An error occurred!") print("Logs sent to Rapid7 Insight (asynchronously).") print("Check your Rapid7 Insight account for these messages.") except Exception as e: print(f"Failed to configure R7InsightHandler: {e}") print("Please ensure R7INSIGHT_TOKEN and R7INSIGHT_REGION are correctly set.")

Debug

Known issues

gotchaThe r7insight-python appender is asynchronous. Logs are queued and sent in the background, which means they might not appear immediately in your Rapid7 Insight account. Do not expect synchronous delivery.

fix

Account for asynchronous delivery in testing and production; allow time for logs to be processed and appear in the Insight console.

affects: All versions

gotchaCorrect configuration requires a 'Token TCP' log source in your Rapid7 Insight account. Using the wrong source type or an incorrect token will prevent logs from being received.

fix

Ensure you create a log in Rapid7 Insight, select 'Token TCP' as the source type, and use the generated Token UUID and the correct region (e.g., 'us', 'eu') when initializing `R7InsightHandler`.

affects: All versions

gotchaTLS (SSL) connection issues are a common point of failure. The library attempts to send logs over TLS on port 443 by default. Some environments may experience issues, leading to 'Unable to connect' errors.

fix

Check network firewalls and proxy settings. As a last resort, for debugging or non-sensitive data, you can set `use_tls=False` and `allow_plaintext_fallback=True` in the `R7InsightHandler` constructor, but this sends logs over plain HTTP on port 80 and is not recommended for production. Example: `R7InsightHandler(TOKEN, REGION, use_tls=False, allow_plaintext_fallback=True)`.

affects: All versions

deprecatedWhile PyPI classifiers for version 1.0.1 list Python 2 compatibility, active development and best practices strongly suggest using Python 3. Rapid7's other related Python projects have moved to Python 3.8+ or higher.

fix

Use Python 3.x for new projects. If migrating from Python 2, ensure all code is Python 3 compatible before using this library.

affects: <=1.0.1

Errors

Common errors & fixes

LE: Unable to connect to R7Insight.

This error typically indicates a network connectivity issue to the Rapid7 Insight ingest server, often due to firewall rules, incorrect proxy settings, or TLS negotiation failures.

fix

Verify that your server has outbound access to the Rapid7 Insight ingest endpoint on port 443 (or 80 if `use_tls=False`). Check local firewall, corporate proxy, and DNS resolution. Setting `use_tls=False, allow_plaintext_fallback=True` in `R7InsightHandler` can help diagnose if TLS is the specific issue, but should be used with caution.

Logs are not appearing in Rapid7 Insight.

This can be due to an incorrect Insight Token, wrong region, a misconfigured log source (not 'Token TCP'), network issues preventing asynchronous delivery, or simply not waiting long enough for logs to process.

fix

Double-check the `TOKEN` and `REGION` values passed to `R7InsightHandler`. Ensure your log source in Rapid7 Insight is configured as 'Token TCP'. Confirm there are no 'Unable to connect' messages in your application logs. Remember the appender is asynchronous, so a delay is expected.

Upgrade

Version history

1.0.1latest on PyPI · released Feb 19, 2025

Audit

Dependencies

certifirequiredRequired for SSL certificate validation.

Agent activity

38 hits · last 30 days

node

OpenAI (training)

Amazon

Resources

packagehttps://pypi.org/project/r7insight-python/ ↗

homepagehttp://pypi.python.org/pypi/R7Insight/ ↗