Search for answers or browse our knowledge base.
Production Applications Best Practices
0 out of 5 stars
5 Stars | 0% | |
4 Stars | 0% | |
3 Stars | 0% | |
2 Stars | 0% | |
1 Stars | 0% |
by Paul Butterworth
April 9, 2019
Revised July 25, 2022
Revision: 0.30
Introduction
We have made a distinction between deployed applications
that are operational and deployed applications that are production. In this
paper we offer some best practices that can be applied to bring an application
into compliance with the production application criteria enumerated in the
document: Deployed Applications: Operational and Production.
Practices for Producing Production Applications
Development and operations staff can apply the following criteria
and methods to bring the quality of an operational application up to the
standard of a production application. Certainly, all of these methods can be
applied but it is also reasonable to be more selective and only apply those
methods required to bring the specific application of interest up to production
standards.
Criteria and methods:
·
Quality hygiene
o
Application produces no errors (aka exceptional conditions)
during normal operation. If a normal run of the application produces errors in
the error log the application is not ready for production. Note that this does
not apply to user errors that are properly handled and reported to the user; it
only applies to errors that are not handled by the application.
o
All diagnostic logging is disabled. An application may produce a
small number of log entries during normal operation but if it is writing
debugging and diagnostic information at more than one record every few seconds,
the application is not suitable for production. Remember there are 86,400
seconds in a day implying that an application that writes 10 log entries a
second will produce nearly a million log records a day. That adds up and you
will quickly exceed your disk quotas.
o
A set of documented tests are available that confirm the proper
operation of the application. It is most useful to have automated regression
tests where practical since these can then be run on demand when changes are
made to the application for bug fixes or enhancements. The tests can also be
run when new versions of the platform are introduced to confirm there is no
impact on the correctness of the application.
·
Scaling hygiene
o
The application does not produce errors when run at scale.
Typically, the additional errors that occur at scale are quota violations
caused by the fact the application is using more resources than it is authorized
to use. The error logs can be scanned to detect such errors. If scaling tests
are producing errors the application is definitely not ready for production.
o
The application has been tested at scale. This does not
necessarily mean it has been tested at full scale – although that is a good
idea – but has been tested with enough of a load that you are confident the
production workload will be serviced properly.
§
A by-product of scale testing is you should know what resources
are required to execute a unit of work within the application. Resources are
normally measured as events ingested or produced and DBMS actions taken. These
measures are proxies for the overall resource consumption of the application.
This information can be used for capacity planning and to estimate the cost of
running the application at greater scale. See the document: Scalable
Application Architectures for additional details.
·
Code management in place
o
A general rule for all software development is that it has to be
possible to re-create the application from its source representation. In VANTIQ
the source representation is the set of resources that comprise the
application. All such resources should be exported and placed under the control
of a version management system such as Git or Team Foundation Services. Note
that any other resources required to reconstitute the complete application
should also be placed under the control of the version management system. For
example, any configuration files, help files, etc. Essentially, everything
needed to recreate the application from scratch should be controlled.
o
Along with application resources, the procedure to deploy the
application should be documented and placed under version control. If you are
using the VANTIQ deployment manager, exporting the configurations, deployments
and environments used to implement the deployment will satisfy this need. If
you are using external procedures and scripts to deploy the application, they
must all be collected and placed under version control along with the
instructions for executing the deployment process.
·
Namespace and Nodes provisioned
o
The application will run in one or more namespaces within the
production installation. The namespaces must be set up in anticipation of
deploying the application. Nodes can be defined as part of the deployment
process and the node definitions must also be placed under source management.
·
User management in place
o
The application is likely to have a user community unless it is a
totally automated system. The users must be provisioned into the production
installation. Note that even if users are provisioned into the development
installation, they must be provisioned again in the production installation.
The normal procedure for provisioning users is to invite them to be authorized
users within the namespace in which the application executes.
o
Profiles that contain appropriate privileges for each user role
are constructed and assigned to the appropriate users.
·
Note that namespace and user provisioning for production
applications is described in detail in:Â Migration to API.
This document describes a number of additional best practices for bringing
applications to production quality.
0 out of 5 stars
5 Stars | 0% | |
4 Stars | 0% | |
3 Stars | 0% | |
2 Stars | 0% | |
1 Stars | 0% |
-
Getting Started
-
- Advanced Collaborations
- Analytics
- App Components
- Assemblies
- Catalogs Tutorial
- Client Builder
- Client Components
- Deployment Tutorial
- Floor Plan
- Introduction to Collaboration
- Natural Language Tutorial
- Sources
- Stateful Services
- System Modeler
- Testing the Debugging Tutorial
- Testing the Introductory Tutorial
- Testing the Source Tutorial
- User and Namespace Administration
- Show Remaining Articles ( 3 ) Collapse Articles
-
Product Documentation
-
-
-
- Accessing Namespaces in the Organization
- Active Resource Control Center
- Adding a New User to an Organization
- Adding a New User to the Application Namespace
- Administrators' Concepts and Terminology
- Authorizing Users to Access the Application
- Creating a Developer Namespace for the Organization Administrator
- Creating a New Application Namespace
- Creating Resources for New Namespaces
- Custom User Invites
- Deploying the GenAI Flow Service Connector
- Developer Tasks
- Handling Administrators Leaving
- Related Configuration
- Removing Namespace Administrators
- Self-Administration Tasks
- System Administration Tasks
- Viewing Lists of Users
- Show Remaining Articles ( 3 ) Collapse Articles
-
- Deploy Results Tab
- Deploying the same application to different environments
- Deployment
- Deployment Tool - Introduction
- Environment
- Environment Tab
- Node
- Project Partitions
- Redeploy On A Failed Node
- Reliable Deployment
- Settings Tab
- The Graph View
- The Tree View
- Undeploy
- Update Partitions
- Verify Application After Deployment
- Show Remaining Articles ( 1 ) Collapse Articles
-
- CheckedInsert/CheckedUpsert Command
- Command Line Options
- Delete Command
- Execute Command
- Export Command
- Find Command
- Help Command
- Import Command
- Insert Command
- Installation - Prerequisites
- Installation - Profile
- List Command
- Load Command
- Recommend Command
- Run Command
- Select Command
- Stop Command
- The Vantiq Command Line Interface (CLI) - Overview
- Upsert Command
- Show Remaining Articles ( 4 ) Collapse Articles
-
- App Execution Dashboard
- App With Split Dashboard
- Dashboard Navigation Bar
- Deprecated Dashboards
- Event Processing Dashboard
- General Dashboard Behavior
- Getting Started with Grafana
- Grafana Usage
- Monitoring Namespaces with Grafana
- Most Commonly Used Dashboards
- Namespace Monitoring Dashboards
- Organization Level Behavior
- Procedure and Rule Execution Dashboards
- Profiling Dashboards
- Reliable Event Dashboard
- Resource Usage Dashboard
- Service Execution Dashboard
- Service Handler Dashboard
- Source Activity Dashboard
- Storage Manager Dashboard
- Tensorflow Model Dashboard
- Type Storage Dashboard
- Show Remaining Articles ( 7 ) Collapse Articles
-
- Access to a Kubernetes Cluster
- Creating a K8s Cluster
- Delayed Processing
- Deploying K8s Installations to a Kubernetes Cluster
- Deploying the K8s Worker
- External Lifecycle Management Guide - Overview
- K8s Worker
- Kubernetes Components of a K8s Installation
- Kubernetes Namespaces
- Loading Images into a Kubernetes Cluster
- Managing K8s Installations
- Other Configuration Options
- System View
- Use of the self Cluster
- Using a Kubernetes Cluster
- Using Templates to Deploy the K8s Worker
- Vantiq Namespaces
- Verify Installation
- Show Remaining Articles ( 3 ) Collapse Articles
-
- Changing the System Password
- Creating a GenAIFlowService Service Connector
- Creating a New Organization and Namespace
- Deployment Methods
- Docker Deployment
- Edge Installation Management
- Edge Vision Server
- Executable JAR Deployment
- MongoDB
- Requirements
- Running the Vantiq Executable
- Setting the default LLMs API key
- Setting Up Vantiq Edge
- Vantiq Edge Reference Guide - Overview
- Vantiq Edge Self Node
- Windows bat file
- Show Remaining Articles ( 1 ) Collapse Articles
-
- Additional Buffer Semantics
- Applicability
- auditFrequency Quota
- Background
- Default Quotas
- Detailed Credit Quotas
- errorBreaker Quota
- errorReportingFrequency Quota
- Execution Credit Quota
- Execution Credit Quota - Diagnostics
- Execution Credit Quota - Mitigation
- Execution Rate Quota
- Execution Rate Quota - Diagnostics
- Execution Rate Quota - Mitigations
- executionTime Quota
- k8sResources Quota
- Quota Interactions
- receiveMessage Quota
- receiveMessage Quota - Diagnostics
- receiveMessage Quota - Mitigation
- reservedGroups Quota
- stackDepth Quota
- Stream Quota
- Terminology
- Workload Management
- Workload Management Conceptual Model
- Show Remaining Articles ( 11 ) Collapse Articles
-
-
-
-
- Advanced Use Cases
- Data Manipulation
- Defining Types
- Discovery from External Data Store
- Error Handling
- Installation and Use
- Native Language Implementation
- Restricting Capabilities
- Service Connectors
- Storage Manager Assembly Contents
- Storage Manager Service API
- Storage Manager Transactions
- Storage Managers - Introduction
- Transaction Support
-
-
-
- App Pane
- Autopsies
- Defining a Run Policy
- Defining a Test Suite - Properties
- Defining an Input
- Defining an Output
- Error Pane
- Integration Tests
- Populate Testing Namespace With Data
- Procedure Pane
- Rule Pane
- Running a Test in the IDE
- Running a Test through the REST Interface
- Source Mocking For Tests
- Unit Tests
- Vantiq Testing Reference Guide - Introduction
- Show Remaining Articles ( 1 ) Collapse Articles
-
-
-
- Assembly Configs
- Audits
- Catalog Members
- Catalogs
- Debug Configs
- Delegated Requests
- Documents
- Event Generators
- Groups
- Images
- K8s Clusters
- K8s Installations
- K8s Workitems
- LLMs
- Logs
- Namespaces
- Nodes
- Organizations
- Procedures
- Profiles
- Projects
- Resource Definition
- Resource Events
- Resource Relationship Model
- Resource Security Model
- Rules
- Scheduled Events
- Secrets
- Semantic Indexes
- Service Connectors
- Services
- Sources
- StorageManagers
- TensorFlowModels
- Test Reports
- Test Suites
- Tests
- Tokens
- Topics
- TrackingRegions
- Types
- Users
- Vantiq Resources
- Videos
- Show Remaining Articles ( 29 ) Collapse Articles
-
- Before Rules
- Built-In Services
- Data Manipulation
- Data Model Declarations
- Declaring Packages
- Defining Remote Connections
- Distributed Processing
- Error Handling
- Event Sending
- External State
- Flow Control
- General Use Procedures
- In-Memory State Management
- Iteration
- Logging
- Operators
- Package Scoping and Name Resolution
- Packages
- Packages
- Persistent State
- Procedure Execution
- Procedures
- PROCESSED BY Clause
- Resource Definition
- RETURN
- Rules
- Services
- Syntax
- Type Specific Procedures
- VAIL Declarations
- VAIL Types
- Variables
- Show Remaining Articles ( 17 ) Collapse Articles
-
-
-
Articles
-
- How To Video Shorts: Client Layouts
- How To Video Shorts: AI Functions
- How To Video Shorts: Analytics and ComputeStatistics
- How To Video Shorts: Calling Procedures by Properties
- How To Video Shorts: Client CSS
- How To Video Shorts: Invite Other Users to Your Namespace
- How To Video Shorts: SplitByGroup
- How To Video Shorts: The Vantiq API
- How To Video Shorts: The Vantiq IDE
- How To Video Shorts: The Vantiq Version Control System
- How To Video Shorts: Using Generative AI in Applications
- How-To Video Shorts: Managing AI Conversations
- How-To Videos: AI Design Model Assistant
- How-To Videos: AI Documentation Search
- Production Applications Best Practices