Debugging
This page has moved to docs.servicestack.net/debugging
It's possible to debug into the ServiceStack source code when using the ServiceStack NuGet packages. You can enable this after enabling SymbolSource integration in VisualStudio:
- Go to
Tools -> Options -> Debugger -> General
- Uncheck Enable Just My Code, Enable .NET Framework source stepping and Require source files to exactly match the original version
- Check Enable source server support
- In the
Tools -> Options -> Debugger -> Symbols
dialog, under the Symbol file (.pdb) locations section by clicking the New Folder icon and add the following urls (in order): - http://referencesource.microsoft.com/symbols - https://nuget.smbsrc.net - http://msdl.microsoft.com/download/symbols
And with that you should now be able to debug into the source code of any NuGet package (who publishes their Symbols) directly from within your application!
ServiceStack allows additional debug information when in DebugMode, which is automatically set by default in Debug builds or explicitly with:
SetConfig(new HostConfig { DebugMode = true });
In addition, users with the Admin role or Requests with an AuthSecret can also view Debug Info in production.
Users in the Admin
role have super-user access giving them access to any services or plugins protected with Roles and Permissions.
You can use Config.AdminAuthSecret to specify a special string to give you admin access without having to login by adding ?authsecret=xxx
to the query string, e.g:
SetConfig(new HostConfig { AdminAuthSecret = "secretz" });
By-pass protected services using query string:
/my-service?authsecret=secretz
To provide better visibility to the hidden functionality in ServiceStack we've added Debug Info links section to the /metadata
page which add links to any Plugins with Web UI's, e.g:
The Debug Links section is only available in DebugMode.
You can add links to your own Plugins in the metadata pages with:
appHost.GetPlugin<MetadataFeature>()
.AddPluginLink("swagger-ui/", "Swagger UI");
appHost.GetPlugin<MetadataFeature>()
.AddDebugLink("?debug=requestinfo", "Request Info");
AddPluginLink
adds links under the Plugin Links section and should be used if your plugin is publicly visible, otherwise use AddDebugLink
for plugins only available during debugging or development.
There are a number of plugins that can help with debugging:
Provides ServiceStack's Request Info feature useful for debugging requests. Just add ?debug=requestinfo in your /pathinfo
and ServiceStack will return a dump of all the HTTP Request parameters to help with with debugging interoperability issues. The RequestInfoFeature is only enabled in DebugMode.
Add an In-Memory IRequestLogger
and service with the default route at /requestlogs
which maintains a live log of the most recent requests (and their responses). Supports multiple config options incl. Rolling-size capacity, error and session tracking, hidden request bodies for sensitive services, etc.
Plugins.Add(new RequestLogsFeature());
The IRequestLogger
is a great way to introspect and analyze your service requests in real-time. Here's a screenshot from the http://bootstrapapi.servicestack.net website:
It supports multiple queryString filters and switches so you filter out related requests for better analysis and debuggability:
The RequestLogsService is just a simple C# service under-the-hood but is a good example of how a little bit of code can provide a lot of value in ServiceStack's by leveraging its generic, built-in features.
- Why ServiceStack?
- Important role of DTOs
- What is a message based web service?
- Advantages of message based web services
- Why remote services should use separate DTOs
-
Getting Started
-
Designing APIs
-
Reference
-
Clients
-
Formats
-
View Engines 4. Razor & Markdown Razor
-
Hosts
-
Security
-
Advanced
- Configuration options
- Access HTTP specific features in services
- Logging
- Serialization/deserialization
- Request/response filters
- Filter attributes
- Concurrency Model
- Built-in profiling
- Form Hijacking Prevention
- Auto-Mapping
- HTTP Utils
- Dump Utils
- Virtual File System
- Config API
- Physical Project Structure
- Modularizing Services
- MVC Integration
- ServiceStack Integration
- Embedded Native Desktop Apps
- Auto Batched Requests
- Versioning
- Multitenancy
-
Caching
-
HTTP Caching 1. CacheResponse Attribute 2. Cache Aware Clients
-
Auto Query
-
AutoQuery Data 1. AutoQuery Memory 2. AutoQuery Service 3. AutoQuery DynamoDB
-
Server Events
-
Service Gateway
-
Encrypted Messaging
-
Plugins
-
Tests
-
ServiceStackVS
-
Other Languages
-
Amazon Web Services
-
Deployment
-
Install 3rd Party Products
-
Use Cases
-
Performance
-
Other Products
-
Future