readme update, resource import fix on windows

dmelikyan · dmelikyan · commit 540a8407d9ce · 2017-07-04T09:25:41.000+02:00
diff --git a/README.md b/README.md
@@ -28,8 +28,9 @@ See full [documentation](https://stackimpact.com/docs/) for reference.
 
 * Linux, OS X or Windows. Python version 2.7, 3.4 or higher.
 * Memory allocation profiler and some GC metrics are only available for Python 3.
-* CPU and Time profilers only support Linux and OS X.
+* Profilers only support Linux and OS X.
 * Time (blocking call) profiler supports threads and gevent.
+* On unix systems the profilers use the following signals: SIGPROF, SIGALRM, SIGUSR2. Only SIGUSR2 is handled transparently, i.e. it should not conflict with previousely registered handlers.
 
 
 ## Getting started
@@ -73,6 +74,8 @@ Other initialization options:
 * `app_environment` (Optional) Used to differentiate applications in different environments.
 * `host_name` (Optional) By default, host name will be the OS hostname.
 * `debug` (Optional) Enables debug logging.
+* `cpu_profiler_disabled`, `allocation_profiler_disabled`, `block_profiler_disabled`, `error_profiler_disabled` (Optional) Disables respective profiler when `True`.
+* `include_agent_frames`, `include_system_frames` (Optional) Set to `True` to not exclude agent and/or system stack frames from profiles.
 
 
 
diff --git a/README.rst b/README.rst
@@ -37,14 +37,17 @@ Documentation
 See full `documentation <https://stackimpact.com/docs/>`__ for
 reference.
 
-Requirements
-------------
+Supported environment
+---------------------
 
 -  Linux, OS X or Windows. Python version 2.7, 3.4 or higher.
--  Memorly allocation profiler and some GC metrics are only available
-   for Python 3.
--  CPU and Time profilers only supports Linux and OS X.
+-  Memory allocation profiler and some GC metrics are only available for
+   Python 3.
+-  Profilers only support Linux and OS X.
 -  Time (blocking call) profiler supports threads and gevent.
+-  On unix systems the profilers use the following signals: SIGPROF,
+   SIGALRM, SIGUSR2. Only SIGUSR2 is handled transparently, i.e. it
+   should not conflict with previousely registered handlers.
 
 Getting started
 ---------------
@@ -58,7 +61,7 @@ Sign up for a free account at
 Installing the agent
 ^^^^^^^^^^^^^^^^^^^^
 
-Install the Go agent by running
+Install the Python agent by running
 
 ::
 
@@ -81,7 +84,10 @@ Configuration section.
 
     agent = stackimpact.start(
         agent_key = 'agent key here',
-        app_name = 'MyPythonApp',
+        app_name = 'MyPythonApp')
+
+Add the agent initialization to the worker code, e.g. wsgi.py, if
+applicable.
 
 Other initialization options:
 
@@ -92,13 +98,19 @@ Other initialization options:
 -  ``host_name`` (Optional) By default, host name will be the OS
    hostname.
 -  ``debug`` (Optional) Enables debug logging.
+-  ``cpu_profiler_disabled``, ``allocation_profiler_disabled``,
+   ``block_profiler_disabled``, ``error_profiler_disabled`` (Optional)
+   Disables respective profiler when ``True``.
+-  ``include_agent_frames``, ``include_system_frames`` (Optional) Set to
+   ``True`` to not exclude agent and/or system stack frames from
+   profiles.
 
 Analyzing performance data in the Dashboard
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Once your application is restarted, you can start observing regular and
-anomaly-triggered CPU, memory, I/O, and other hot spot profiles,
-execution bottlenecks as well as process metrics in the
+Once your application is restarted, you can start observing continuous
+CPU, memory, I/O, and other hot spot profiles, execution bottlenecks as
+well as process metrics in the
 `Dashboard <https://dashboard.stackimpact.com/>`__.
 
 Troubleshooting
diff --git a/stackimpact/reporters/block_reporter.py b/stackimpact/reporters/block_reporter.py
@@ -110,7 +110,8 @@ def process_sample(self, signal_frame, sample_time, main_thread_id):
             start = time.clock()
 
             current_frames = sys._current_frames()
-            for thread_id, thread_frame in current_frames.items():
+            items = current_frames.items()
+            for thread_id, thread_frame in items:
                 if thread_id == main_thread_id:
                     thread_frame = signal_frame
 
@@ -121,6 +122,7 @@ def process_sample(self, signal_frame, sample_time, main_thread_id):
 
                 thread_id, thread_frame, stack = None, None, None
 
+            items = None
             current_frames = None
 
             self.block_profile._overhead += (time.clock() - start)
diff --git a/stackimpact/runtime.py b/stackimpact/runtime.py
@@ -6,7 +6,10 @@
 import os
 import signal
 from functools import wraps
-
+try:
+    import resource
+except ImportError:
+    pass
 
 
 class runtime_info:
