Misleading documentation, profiler doesn't work on Windows

stackimpact / stackimpact-python

DEPRECATED StackImpact Python Profiler - Production-Grade Performance Profiler: CPU, memory allocations, blocking calls, exceptions, metrics, and more

https://stackimpact.com

BSD 3-Clause "New" or "Revised" License

659 stars 25 forks source link

Misleading documentation, profiler doesn't work on Windows #6

Open Kaju-Bubanja opened 5 years ago

Kaju-Bubanja commented 5 years ago

Enabling debug, shows

CPU profiler is only supported on Linux and OS X.

which is the main thing I would expect from a profiler... So maybe add a warning that this can't be used on windows as people would normally understand it.

dmelikyan commented 5 years ago

The Supported Environment section of the readme says that "Profilers only support on Linux and OS X".

Some parts of the agent can work on Windows. Also the development environment, where the agent is integrated, may be Windows. Therefore, we do not explicitly warn about it or throw errors. Besides that the agent is completely silent when debug logging is off.