{"id":67440,"date":"2024-09-30T18:25:40","date_gmt":"2024-09-30T12:55:40","guid":{"rendered":"https:\/\/www.tothenew.com\/blog\/?p=67440"},"modified":"2024-10-03T13:05:31","modified_gmt":"2024-10-03T07:35:31","slug":"exploring-garnet-a-next-generation-cache-store-by-microsoft","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/exploring-garnet-a-next-generation-cache-store-by-microsoft\/","title":{"rendered":"Exploring Garnet: A Next-Generation Cache-Store By Microsoft"},"content":{"rendered":"

Garnet is an exciting project from Microsoft Research that addresses the ever-growing demand for efficient data storage mechanisms to support interactive web applications and services. Let\u2019s dive into the details:<\/p>\n

Introducing Garnet: A Next-Generation Cache-Store<\/h3>\n

What Is Garnet?<\/h4>\n

Garnet is an open-source, next-generation cache-store system designed to offer high performance, extensibility, and low latency. Researchers at Microsoft have been working on Garnet for nearly a decade, aiming to tackle the challenges posed by the rapid advances in interactive web applications and services.<\/p>\n

Key Advantages of Garnet:<\/h4>\n
    \n
  1. Performance Gains<\/strong>: Garnet has been deployed in various use cases at Microsoft, including the Windows & Web Experiences Platform, Azure Resource Manager, and Azure Resource Graph. Its performance improvements over legacy cache-stores are significant.<\/li>\n
  2. Extensibility<\/strong>: Unlike some existing cache systems, Garnet is explicitly designed to be easily extensible by application developers. This means you can build on its capabilities and tailor it to your specific needs.<\/li>\n
  3. Rich Feature Set<\/strong>: Garnet supports more than just simple get\/set operations. It offers APIs for raw strings, analytic data structures (like Hyperloglog), and complex data types (such as sorted sets and hash). Additionally, it allows users to checkpoint and recover the cache, create data shards, maintain replicated copies, and even handle transactions.<\/li>\n
  4. Thread-Scalable<\/strong>: Garnet scales well within a single node, making it suitable for multi-core architectures.<\/li>\n
  5. Open Source<\/strong>: Garnet is now available as an open-source download on GitHub. Microsoft aims to encourage collaboration, academic research, and further development in this critical area by open-sourcing it.<\/li>\n<\/ol>\n

    Use Cases and Deployment<\/h4>\n

    Garnet has already found its way into various Microsoft services, demonstrating its practical applicability. Whether you\u2019re dealing with Windows applications, web experiences, or managing resources in Azure, Garnet can help improve performance and reduce operational costs.<\/p>\n

    How to Get Started with Garnet<\/h3>\n

    If you\u2019re interested in exploring Garnet further, head over to the official Garnet GitHub repository to access the source code, documentation, and community discussions.<\/p>\n

    Use Docker for localhost work<\/p>\n

    docker run --network=host --ulimit memlock=-1 ghcr.io\/microsoft\/garnet<\/pre>\n
    On Linux configured with basic authentication, replace\u00a0{{replace_password_here}}\u00a0with your password<\/p>\n
    docker run --network=host --ulimit memlock=-1 ghcr.io\/microsoft\/garnet --auth Password --password {{replace_password_here}}<\/pre>\n
    Examples<\/h3>\n
    Garnet with Console Application<\/h4>\n
    Garnet implementation is as easy as RedisStack.<\/p>\n
    using System;\u00a0\u00a0\r\nusing System.Threading.Tasks;\u00a0 \r\nusing Garnet.Client;\u00a0 \r\nnamespace GarnetClientSample\u00a0 \r\n{\u00a0 \r\n  \u00a0 class Program\u00a0\u00a0\r\n  \u00a0 {\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 static async Task Main(string[] args)\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 {\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Replace with your Garnet server details (hostname and port)\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 var garnetServer = new GarnetServer(\"localhost\", 6379);\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 try\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Connect to the Garnet server\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 await garnetServer.ConnectAsync();\u00a0\u00a0\r\n\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Set a key-value pair\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 await garnetServer.SetAsync(\"myKey\", \"Hello, Garnet!\");\u00a0\u00a0\r\n\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Retrieve the value for a key\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 var retrievedValue = await garnetServer.GetAsync(\"myKey\");\u00a0\u00a0\r\n\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 Console.WriteLine($\"Retrieved value: {retrievedValue}\");\u00a0\u00a0\r\n\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Delete the key\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 await garnetServer.DeleteAsync(\"myKey\");\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 catch (Exception ex)\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 Console.WriteLine($\"Error: {ex.Message}\");\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 finally\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \/\/ Clean up and disconnect\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 await garnetServer.DisconnectAsync();\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\u00a0\u00a0\r\n  \u00a0 \u00a0 \u00a0 }\u00a0\u00a0\r\n  \u00a0 }\u00a0\u00a0\r\n}<\/pre>\n
    Garnet with ASP.NET WebAPI C#<\/h4>\n
    In Program.cs or startup.cs<\/p>\n
    using Garnet.Server; \r\n\/\/ ... \r\n\r\npublic void ConfigureServices(IServiceCollection services)\u00a0\r\n{ \r\n  \u00a0 \/\/ Other services...\u00a0\r\n  \u00a0 services.AddGarnet(options =>\u00a0\r\n  \u00a0 {\u00a0\r\n  \u00a0 \u00a0 \u00a0 options.Hostname = \"localhost\"; \/\/ Garnet server hostname\u00a0\r\n  \u00a0 \u00a0 \u00a0 options.Port = 6379; \/\/ Garnet server port\u00a0\r\n  \u00a0 });\u00a0\r\n}<\/pre>\n
    In Controller class<\/p>\n
    using System;\u00a0\r\nusing System.Threading.Tasks; \r\nusing Garnet.Client; \r\nusing Microsoft.AspNetCore.Mvc; \r\n\r\nnamespace GarnetWebApi.Controllers \r\n{ \r\n\r\n\u00a0 \u00a0 [ApiController]\u00a0\r\n  \u00a0 [Route(\"api\/[controller]\")]\u00a0\r\n  \u00a0 public class CacheController : ControllerBase \r\n  \u00a0 {\u00a0\r\n  \u00a0 \u00a0 \u00a0 private readonly GarnetServer _garnetServer;\u00a0\r\n  \u00a0 \u00a0 \u00a0 public CacheController(GarnetServer garnetServer)\u00a0\r\n  \u00a0 \u00a0 \u00a0 {\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 _garnetServer = garnetServer; \r\n  \u00a0 \u00a0 \u00a0 }\u00a0\r\n\r\n\u00a0 \u00a0 \u00a0 \u00a0 [HttpGet(\"{key}\")]\u00a0\r\n  \u00a0 \u00a0 \u00a0 public async Task<IActionResult> Get(string key)\u00a0\r\n  \u00a0 \u00a0 \u00a0 { \r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 try\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 var value = await _garnetServer.GetAsync(key);\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 return Ok(value);\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 catch (Exception ex)\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 return BadRequest($\"Error: {ex.Message}\"); \r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\u00a0\r\n  \u00a0 \u00a0 \u00a0 }\u00a0\r\n\r\n\u00a0 \u00a0 \u00a0 \u00a0 [HttpPost(\"{key}\")]\u00a0\r\n  \u00a0 \u00a0 \u00a0 public async Task<IActionResult> Set(string key, [FromBody] string value)\u00a0\r\n  \u00a0 \u00a0 \u00a0 {\u00a0 \r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 try \r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 await _garnetServer.SetAsync(key, value);\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 return Ok(\"Value set successfully!\");\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 } \r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 catch (Exception ex)\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 {\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 return BadRequest($\"Error: {ex.Message}\");\u00a0\r\n  \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 }\u00a0\r\n  \u00a0 \u00a0 \u00a0 }\u00a0\r\n  \u00a0 } \r\n}<\/pre>\n
    Garnet is way more than this, so please feel free to try it in your project’s cache requirement or try it just for fun.<\/p>\n
    Happy Coding \ud83d\ude80<\/p>\n
     <\/p>\n
    Sources:<\/h3>\n