Web Farms and Web Garden Support

  • 6 minutes to read

This document describes key concepts and requirements for Web reporting applications that operate in a clustered web environment (Web Farms or Web Garden).

Overview

A web farm is comprised of two or more web servers (or nodes) that host multiple instances of an application and share the same IP address. User requests are sent to a single virtual web server, and the load balancer selects a web farm's node to handle the request. A web garden is a web server that operates on a single machine. Web server configuration allows an application to run on multiple worker processes in an application pool and distributes the work to multiple CPUs.

Large web applications can benefit from the increased performance, reliability, and availability the clustered environment provides.

NOTE

If you use Azure App Service, review the following topic: Microsoft Azure Reporting.

Document and Report Cache

The Document Viewer component and the Report Designer component in Preview mode need access to the document while it is being generated.

For more information on the document generation process, review the following topic: Document Viewer Lifecycle.

In the distributed clustered environment there are two options: use ARR affinity so that all requests are routed to the same process or implement a document cache shared between processes.

Application Request Routing (ARR) on Web Farm

This option ensures that all user requests are handled by the same physical server/process where the report creation process was started. Otherwise, a new request sent to another server fails to find the necessary report. It means that each request initiated by a unique client should go to the same server. The load balancer must be instructed to use Application Request Routing (ARR) and provide client affinity (sticky session) to route all user requests to the same web server.

Share Reports and Documents Between Application Instances

If ARR affinity is not an option, an application should be configured to allow report and document sharing between application instances. The easiest solution is a shared folder that is accessible by both servers.

To implement this solution, modify your application to meet the following requirements:

IMPORTANT

Make sure that all the web farm's nodes have access to the folder used as file storage.

Report and Document TTL Settings

Shared Machine Key

The End-User Report Designer requires that all nodes in the Web Farm have the same value for validationKey and decryptionKey (which comprise the machine key). These values are used to encrypt and decrypt connection parameters sent to the client. A shared machine key is necessary because the Load Balancer can route successive requests to different servers.

Do one of the following to meet this requirement:

  • Use connections names instead of connection parameters. Connection names do not need encryption and the machine key is unnecessary. This approach requires a global service that implements the IConnectionProviderFactory interface to resolve connection names. Note that the connection provider factory should resolve names for connections listed in the web.config/appsettings.json configuration files.
  • Share the machine key to make it available for all the Web Farm's nodes.
See Also