call_end

    • chevron_right

      ProcessOne: ejabberd 24.12

      news.movim.eu / PlanetJabber • 19 December, 2024 • 10 minutes

    ejabberd 24.12

    Here comes ejabberd 24.12, including a few improvements and bug fixes. This release comes a month and half after 24.10, with around 60 commits to the core repository alongside a few updates in dependencies.

    Release Highlights:

    Among them, the evacuate_kindly command is a new tool which gave the funny codename to this release. It lets you stop and rerun ejabberd without letting users reconnect to let you perform your maintenance task peacefully. So, this is not an emergency exit from ejabberd, but instead testimony that this releasing is paving the way for a lot of new cool stuff in 2025.

    Other contents:

    If you are upgrading from a previous version, there are no required changes in the SQL schemas, configuration or hooks. There are some Commands API v3 .

    Below is a detailed breakdown of the improvements and enhancements:

    XEP-0484: Fast Authentication Streamlining Tokens

    We added support for XEP-0484: Fast Authentication Streamlining Tokens . This allows clients to request time limited tokens from servers, which then can be later used for faster authentication by requiring less round trips. To enable this feature, you need to add mod_auth_fast module in modules section.

    Deprecation schedule for Erlang/OTP older than 25.0

    It is expected that around April 2025, GitHub Actions will remove Ubuntu 20 and it will not be possible to run automatically dynamic tests for ejabberd using Erlang/OTP older than 25.0.

    For that reason, the planned schedule is:

    • ejabberd 24.12

      • Usage of Erlang/OTP older than 25.0 is still supported, but discouraged
      • Anybody still using Erlang 24.3 down to 20.0 is encouraged to upgrade to a newer version. Erlang/OTP 25.0 and higher are supported. For instance, Erlang/OTP 26.3 is used for the binary installers and container images.
    • ejabberd 25.01 (or later)

      • Support for Erlang/OTP older than 25.0 is deprecated
      • Erlang requirement softly increased in configure.ac
      • Announce: no warranty ejabberd can compile, start or pass the Common Tests suite using Erlang/OTP older than 25.0
      • Provide instructions for anybody to manually re-enable it and run the tests
    • ejabberd 25.01+1 (or later)

      • Support for Erlang/OTP older than 25.0 is removed completely in the source code

    Commands API v3

    This ejabberd 24.12 release introduces ejabberd Commands API v3 because some commands have changed arguments and result formatting. You can continue using API v2; or you can update your API client to use API v3. Check the API Versions History .

    Some commands that accepted accounts or rooms as arguments, or returned JIDs, have changed their arguments and results names and format to be consistent with the other commands:

    • Arguments that refer to a user account are now named user and host
    • Arguments that refer to a MUC room are now named room and service
    • As seen, each argument is now only the local or server part, not the JID
    • On the other hand, results that refer to user account or MUC room are now the JID

    In practice, the commands that change in API v3 are:

    If you want to update ejabberd to 24.12, but prefer to continue using an old API version with mod_http_api , you can set this new option:

    modules:
      mod_http_api:
        default_version: 2
    

    Improvements in commands

    There are a few improvements in some commands:

    • create_rooms_file : Improved, now it supports vhosts with different config
    • evacuate_kindly : New command to kick users and prevent login ( #4309 )
    • join_cluster : Improved explanation: this returns immediately (since 5a34020, 24.06)
    • mod_muc_admin : Renamed arguments name to room for consistency, with backwards support (no need to update API clients)

    Use non-standard STUN port

    STUN via UDP can easily be abused for reflection/amplification DDoS attacks. Suggest a non-standard port to make it harder for attackers to discover the service in ejabberd.yml.example .

    Modern XMPP clients discover the port via XEP-0215, so there&aposs no advantage in sticking to the standard port.

    Disable the systemd watchdog by default

    Some users reported ejabberd being restarted by systemd due to missing watchdog pings despite the actual service operating just fine. So far, we weren&apost able to track down the issue, so we&aposll no longer enable the watchdog in our example service unit.

    Define macro as environment variable

    ejabberd allows you to define macros in the configuration file since version 13.10. This allows to define a value once at the beginning of the configuration file, and use that macro to setup options values several times during the file.

    Now it is possible to define the macro value as an environment variable. The environment variable name should be EJABBERD_MACRO_ + macro name .

    For example, if you configured in ejabberd.yml :

    define_macro:
      LOGLEVEL: 4
    
    loglevel: LOGLEVEL
    

    Now you can define (and overwrite) that macro definition when starting ejabberd. For example, if starting ejabberd in interactive mode:

    EJABBERD_MACRO_LOGLEVEL=5 make relive
    

    This is specially useful when using containers with slightly different values (different host, different port numbers...): instead of having a different configuration file for each container, now you can use a macro in your custom configuration file, and define different macro values as environment variable when starting each container. See some examples usages in CONTAINER&aposs composer examples

    Elixir modules for authentication

    ejabberd modules can be written in the Elixir programming language since ejabberd 15.02. And now, ejabberd authentication methods can also be written in Elixir!

    This means you can write a custom authentication method in Erlang or in Elixir, or write an external authentication script in any language you want.

    There&aposs an example authentication method in the lib/ directory. Place your custom authentication method in that directory, compile ejabberd, and configure it in ejabberd.yml :

    auth_method: &aposEjabberd.Auth.Example&apos
    

    For consistency with that file naming scheme, the old mod_presence_demo.ex has been renamed to mod_example.ex . Other minor changes were done on the Elixir example code.

    Redis now supports Unix Domain Socket

    Support for Unix Domain Socket was added to listener&aposs port option in ejabberd 20.07. And more recently, ejabberd 24.06 added support in sql_server when using MySQL or PostgreSQL.
    That feature is useful to improve performance and security when those programs are running on the same machine as ejabberd.

    Now the redis_server option also supports Unix Domain Socket.

    The syntax is similar to the other options, simply setup unix: followed with the full path to the socket file. For example:

    redis_server: "unix:/var/run/redis/redis.socket"
    

    Additionally, we took the opportunity to update from the wooga/eredis erlang library which hasn&apost been updated in the last six years, to the Nordix/eredis fork which is actively maintained.

    New evacuate_kindly command

    ejabberd has nowadays around 180 commands to perform many administrative tasks. Let&aposs review some of their usage cases:

    • Did you modify the configuration file? Reload the configuration file and apply its changes

    • Did you apply some patch to ejabberd source code? Compile and install it, and then update the module binary in memory

    • Did you update ejabberd-contrib specs, or improved your custom module in .ejabberd-module ? Call module_upgrade to compile and upgrade it into memory

    • Did you upgrade ejabberd, and that includes many changes? Compile and intall it, then restart ejabberd completely

    • Do you need to stop a production ejabberd which has users connected? stop_kindly the server, informing users and rooms

    • Do you want to stop ejabberd gracefully? Then simply stop it

    • Do you need to stop ejabberd immediately, without worrying about the users? You can halt ejabberd abruptly

    Now there is a new command, evacuate_kindly , useful when you need ejabberd running to perform some administrative task, but you don&apost want users connected while you perform those tasks.

    It stops port listeners to prevent new client or server connections, informs users and rooms, and waits a few seconds or minutes, then restarts ejabberd. However, when ejabberd is started again, the port listeners are stopped: this allows to perform administrative tasks, for example in the database, without having to worry about users.

    For example, assuming ejabberd is running and has users connected. First let&aposs evacuate all the users:

    ejabberdctl evacuate_kindly 60 \"The server will stop in one minute.\"
    

    Wait one minute, then ejabberd gets restarted with connections disabled.
    Now you can perform any administrative tasks that you need.
    Once everything is ready to accept user connections again, simply restart ejabberd:

    ejabberdctl restart
    

    Acknowledgments

    We would like to thank the contributions to the source code, documentation, and translation provided for this release by:

    And also to all the people contributing in the ejabberd chatroom, issue tracker...

    Improvements in ejabberd Business Edition

    Customers of the ejabberd Business Edition , in addition to all those improvements and bugfixes, also get support for Prometheus.

    Prometheus support

    Prometheus can now be used as a backend for mod_mon in addition to statsd, influxdb, influxdb2, datadog and dogstatsd.

    You can expose all mod_mon metrics to Prometheus by adding a http listener pointing to mod_prometheus , for example:

      -
        port: 5280
        module: ejabberd_http
        request_handlers:
          "/metrics": mod_prometheus
    

    You can then add a scrape config to Prometheus for ejabberd:

    scrape_configs:
      - job_name: "ejabberd"
        static_configs:
          - targets:
              - "ejabberd.domain.com:5280"
    

    You can also limit the metrics to a specific virtual host by adding it&aposs name to the path:

    scrape_configs:
      - job_name: "ejabberd"
        static_configs:
          - targets:
              - "ejabberd.domain.com:5280"
         metrics_path: /metrics/myvhost.domain.com
    

    Fix

    • PubSub: fix issue on get_item_name with p1db storage backend.

    ChangeLog

    This is a more detailed list of changes in this ejabberd release:

    Miscelanea

    • Elixir: support loading Elixir modules for auth ( #4315 )
    • Environment variables EJABBERD_MACRO to define macros
    • Fix problem starting ejabberd when first host uses SQL, other one mnesia
    • HTTP Websocket: Enable allow_unencrypted_sasl2 on websockets ( #4323 )
    • Relax checks for channels bindings for connections using external encryption
    • Redis: Add support for unix domain socket ( #4318 )
    • Redis: Use eredis 1.7.1 from Nordix when using mix/rebar3 and Erlang 21+
    • mod_auth_fast : New module with support XEP-0484: Fast Authentication Streamlining Tokens
    • mod_http_api : Fix crash when module not enabled (for example, in CT tests)
    • mod_http_api : New option default_version
    • mod_muc : Make rsm handling in disco items, correctly count skipped rooms
    • mod_offline : Only delete offline msgs when user has MAM enabled ( #4287 )
    • mod_priviled : Handle properly roster iq
    • mod_pubsub : Send notifications on PEP item retract
    • mod_s2s_bidi : Catch extra case in check for s2s bidi element
    • mod_scram_upgrade : Don&apost abort the upgrade
    • mod_shared_roster : The name of a new group is lowercased
    • mod_shared_roster : Get back support for groupid@vhost in displayed

    Commands API

    • Change arguments and result to consistent names (API v3)
    • create_rooms_file : Improve to support vhosts with different config
    • evacuate_kindly : New command to kick users and prevent login ( #4309 )
    • join_cluster : Explain that this returns immediately (since 5a34020, 24.06)
    • mod_muc_admin : Rename argument name to room for consistency

    Documentation

    • Fix some documentation syntax, add links to toplevel, modules and API
    • CONTAINER.md : Add kubernetes yaml examples to use with podman
    • SECURITY.md : Add security policy and reporting guidelines
    • ejabberd.service : Disable the systemd watchdog by default
    • ejabberd.yml.example : Use non-standard STUN port

    WebAdmin

    • Shared group names are case sensitive, use original case instead of lowercase
    • Use lowercase username and server authentication credentials
    • Fix calculation of node&aposs uptime days
    • Fix link to displayed group when it is from another vhost

    Full Changelog

    https://github.com/processone/ejabberd/compare/24.10...24.12

    ejabberd 24.12 download & feedback

    As usual, the release is tagged in the Git source code repository on GitHub .

    The source package and installers are available in ejabberd Downloads page. To check the *.asc signature files, see How to verify ProcessOne downloads integrity .

    For convenience, there are alternative download locations like the ejabberd DEB/RPM Packages Repository and the GitHub Release / Tags .

    The ecs container image is available in docker.io/ejabberd/ecs and ghcr.io/processone/ecs . The alternative ejabberd container image is available in ghcr.io/processone/ejabberd .

    If you consider that you&aposve found a bug, please search or fill a bug report on GitHub Issues .

    • chevron_right

      JMP: Newsletter: JMP at SeaGL, Cheogram now on Amazon

      news.movim.eu / PlanetJabber • 18 December, 2024 • 2 minutes

    Hi everyone!

    Welcome to the latest edition of your pseudo-monthly JMP update!

    In case it’s been a while since you checked out JMP, here’s a refresher: JMP lets you send and receive text and picture messages (and calls) through a real phone number right from your computer, tablet, phone, or anything else that has a Jabber client.  Among other things, JMP has these features: Your phone number on every device; Multiple phone numbers, one app; Free as in Freedom; Share one number with multiple people.

    JMP at SeaGL

    The Seattle GNU/Linux Conference (SeaGL) is happening next week and JMP will be there!  We’re going to have a booth with some of our employees, and will have JMP eSIM Adapters and USB card readers for purchase (if you prefer to save on shipping, or like to pay cash or otherwise), along with stickers and good conversations. :)  The exhibition area is open all day on Friday and Saturday, November 8 and 9, so be sure to stop by and say hi if you happen to be in the area.  We look forward to seeing you!

    Cheogram Android in Amazon Appstore

    We have just added Cheogram Android to the Amazon Appstore !  And we also added Cheogram Android to Aptoide earlier this month.  While F-Droid remains our preferred official source, we understand many people prefer to use stores that they’re used to, or that come with their device.  We also realize that many people have been waiting for Cheogram Android to return to the Play Store, and we wanted to provide this other option to pay for Cheogram Android while Google works out the approval process issues on their end to get us back in there.  We know a lot of you use and recommend app store purchases to support us, so let your friends know about this new Amazon Appstore option for Cheogram Android if they’re interested!

    New features in Cheogram Android

    As usual, we’ve added a bunch of new features to Cheogram Android over the past month or so.  Be sure to update to the latest version ( 2.17.2-1 ) to check them out!  (Note that Amazon doesn’t have this version quite yet, but it should be there shortly.)  Here are the notable changes since our last newsletter: privacy-respecting link previews (generated by sender), more familiar reactions, filtering of conversation list by account, nicer autocomplete for mentions and emoji, and fixes for Android 15, among many others.

    To learn what’s happening with JMP between newsletters, here are some ways you can find out:

    • wifi_tethering open_in_new

      This post is public

      blog.jmp.chat /b/october-newsletter-2024

    • chevron_right

      JMP: Newsletter: Year in Review, Google Play Update

      news.movim.eu / PlanetJabber • 18 December, 2024 • 3 minutes

    Hi everyone!

    Welcome to the latest edition of your pseudo-monthly JMP update!

    In case it’s been a while since you checked out JMP, here’s a refresher: JMP lets you send and receive text and picture messages (and calls) through a real phone number right from your computer, tablet, phone, or anything else that has a Jabber client.  Among other things, JMP has these features: Your phone number on every device; Multiple phone numbers, one app; Free as in Freedom; Share one number with multiple people.

    As we approach the close of 2024, we want to take a moment to reflect on a year full of growth, innovation, and connection. Thanks to your support and engagement, JMP has continued to thrive as a service that empowers you to stay connected with the world using open standards and flexible technology. Here’s a look back at some of the highlights that made this year so special:

    Cheogram Android

    Cheogram Android, which we sponsor, experienced significant developments this year. Besides the preferred distribution channel of F-Droid , the app is also available on other platforms like Aptoide and the Amazon Appstore . It was removed from the Google Play Store in September for unknown reasons, and after a long negotiation has been restored to Google Play without modification.

    Cheogram Android saw several exciting feature updates this year, including:

    • Major visual refresh
    • Animated custom emoji
    • Better Reactions UI (including custom emoji reactions)
    • Widgets powered by WebXDC for interactive chats and app extensions
    • Initial support for link previews
    • The addition of a navigation drawer to show chats from only one account or tag
    • Allowing edits to any message you have sent

    This month also saw the release of 2.17.2-3 including:

    • Fix direct shares on Android 12+
    • Option to hide media from gallery
    • Do not re-notify dismissed notifications
    • Experimental extensions support based on WebXDC
    • Experimental XEP-0227 export support

    Of course nothing in Cheogram Android would be possible without the hard work of the upstream project, Conversations , so thanks go out to the devs there as well.

    eSIM Adapter Launch

    This year, we introduced the JMP eSIM Adapter —a device that bridges the gap for devices without native eSIM support, and adds flexibility for devices with eSIM support. Whether you’re travelling, upgrading your device, or simply exploring new options, the eSIM Adapter makes it seamless to transfer eSIMs across your devices.

    Engaging with the Community

    This year, we hosted booths at SeaGL, FOSSY, and HOPE, connecting with all of you in person. These booths provided opportunities to learn about our services, pay for subscriptions, or purchase eSIM Adapters face-to-face.

    Addressing Challenges

    In 2024, we also tackled some pressing industry issues, such as SMS censorship . To help users avoid censorship and gain access to bigger MMS group chats, we’ve added new routes that you can request from our support team .

    As part of this, we also rolled out the ability for JMP customers to receive calls directly over SIP .

    Holiday Support Schedule

    We want to inform you that JMP support will be reduced from our usual response level from December 23 until January 6 . During this period, response times will be significantly longer than usual as our support staff take time with their families. We appreciate your understanding and patience.

    Looking Ahead

    As we move into 2025, we’re excited to keep building on this momentum. Expect even more features, improved services, and expanded opportunities to connect with the JMP community. Your feedback has been, and will always be, instrumental in shaping the future of JMP.

    To learn what’s happening with JMP between newsletters, here are some ways you can find out:

    • wifi_tethering open_in_new

      This post is public

      blog.jmp.chat /b/december-newsletter-2024

    • chevron_right

      Erlang Solutions: Meet the team: Erik Schön

      news.movim.eu / PlanetJabber • 10 December, 2024 • 2 minutes

    In our final “Meet the Team” of 2024, we’d like to introduce you to Erik Schön, Managing Director at Erlang Solutions.

    Erik shares his journey with Erlang, Elixir, and the BEAM ecosystem, from his work at Ericsson to joining Erlang Solutions in 2019. He also reflects on a key professional highlight in 2024 and looks ahead to his goals for 2025. Erik also reveals his festive traditions, including a Swedish-Japanese twist.

    About Erik

    So tell us about yourself and your role at Erlang Solutions .

    Hello, I’m Erik! I’ve been a big fan of all things Erlang/Elixir/BEAM since the 90s, having seen many successful applications of it when working at Ericsson as an R&D manager for many years.

    Since 2019, I’ve been part of the Erlang Solutions Nordic Fjällrävens (“Arctic Foxes”) team based in Stockholm, Sweden. I love helping our customers succeed by delivering faster, safer, and more efficient solutions.

    What has been a professional highlight of yours in 2024?

    The highlight of 2024 for me was our successful collaboration with BoardClic, a startup that helps its customers with digital board and C-suite level performance evaluations.

    We started our collaboration with a comprehensive code-/architecture review of their Elixir codebase, using our 25 years of experience in delivering software for societal infrastructure, including all the do’s and don’ts for future-proof, secure, resilient, and scalable solutions.

    Based on this, we boosted their development of new functionality for a strategically important customer—from idea to live, commercial operation. Two of our curious, competent collaborators, with 10+ years of practical, hands-on Elixir/Erlang/BEAM expertise, worked closely with BoardClic on-site to deliver on time and with quality.

    What professional and personal achievements are you looking forward to achieving in 2025?

    Professionally, I look forward to continued success with our customers. This includes strengthening our long-standing partnerships with TV4, Telia, Ericsson, and Cisco . I’m also excited about the start of new partnerships, both inside and outside the BEAM community where we will continue to deliver more team-based, full-stack, end-to-end solutions.

    Personally, I look forward to continuing to talk about my trilogy of books – The Art of Change, The Art of Leadership and The Art of Strategy – in podcasts, meetups and conferences.

    Do you have any festive traditions that you’re looking forward to this holiday season?

    In Sweden, julbord (a buffet-style table of small dishes including different kinds of marinated fish like herring and salmon, meatballs, ham, porridge, etc)  is a very important tradition to look forward to. Since my wife is from Japan, we always try to spice things up a bit by including suitable dishes from the Japanese kitchen, like different kinds of sushi.

    Final thoughts

    As we wrap up our 2024 meet-the-team series, a big thank you to Erik and all the incredible team members we’ve highlighted this year. Their passion, expertise, and dedication continue to drive our success.

    Stay tuned for more insights and profiles in the new year as we introduce even more of the talented people who make Erlang Solutions what it is! if you’d like to speak more with our team, please get in touch .

    The post Meet the team: Erik Schön appeared first on Erlang Solutions .

    • chevron_right

      Erlang Solutions: Advent of Code 2024

      news.movim.eu / PlanetJabber • 4 December, 2024 • 3 minutes

    Welcome to Advent of Code 2024!

    Like every year, I start the challenge with the best attitude and love of being an Elixir programmer. Although I know that at some point, I will go to the “what is this? I hate it” phase, unlike other years, this time, I am committed to finishing Advent of Code and, more importantly, sharing it with you.

    I hope you enjoy this series of December posts, where we will discuss the approach for each exercise. But remember that it is not the only one, and the idea of ​​this initiative is to have a great time and share knowledge, so don’t forget to post your solutions and comments and tag us to continue the conversation.

    Let’s go for it!

    Day 1: Historian Hysteria

    Before starting any exercise, I suggest spending some time defining the structure that best fits the problem’s needs. If the structure is adequate, it will be easy to reuse it for the second part without further complications.

    In this case, the exercise itself describes lists as the input, so we can skip that step and instead consider which functions of the Enum or List modules can be helpful.

    We have this example input:

    3 4

    4 3

    2 5

    1 3

    3 9

    3   3

    The goal is to transform it into two separate lists and apply sorting, comparison, etc.

    List 1: [3, 4, 2, 1, 3, 3 ]

    List 2: [ 4, 3, 5, 3, 9, 3 ]

    Let’s define a function that reads a file with the input. Each line will initially be represented by a string, so use String . split to separate it at each line break.

     def get_input(path) do
       path
       |> File.read!()
       |> String.split("\n", trim: true)
     end
    
    
    ["3   4", "4   3", "2   5", "1   3", "3   9", "3   3"]
    

    We will still have each row represented by a string, but we can now modify this using the functions in the Enum module. Notice that the whitespace between characters is constant, and the pattern is that the first element should go into list one and the second element into list two. Use Enum.reduce to map the elements to the corresponding list and get the following output:


    %{
     first_list: [3, 3, 1, 2, 4, 3],
     second_list: [3, 9, 3, 5, 3, 4]
    }
    
    

    I’m using a map so that we can identify the lists and everything is clear. The function that creates them is as follows:

     @doc """
     This function takes a list where the elements are strings with two
     components separated by whitespace.
    
    
     Example: "3   4"
    
    
     It assigns the first element to list one and the second to list two,
     assuming both are numbers.
     """
     def define_separated_lists(input) do
       Enum.reduce(input, %{first_list: [], second_list: []}, fn row, map_with_lists ->
         [elem_first_list, elem_second_list] = String.split(row, "   ")
    
    
         %{
           first_list: [String.to_integer(elem_first_list) | map_with_lists.first_list],
           second_list: [String.to_integer(elem_second_list) | map_with_lists.second_list]
         }
       end)
     end
    

    Once we have this format, we can move on to the first part of the exercise.

    Part 1

    Use Enum.sort to sort the lists ascendingly and pass them to the Enum.zip_with function that will calculate the distance between the elements of both. Note that we are using abs to avoid negative values, and finally, Enum.reduce to sum all the distances.

    first_sorted_list = Enum.sort(first_list)
       second_sorted_list = Enum.sort(second_list)
    
    
       first_sorted_list
       |> Enum.zip_with(second_sorted_list, fn x, y -> abs(x-y) end)
       |> Enum.reduce(0, fn distance, acc -> distance + acc end)
    

    Part 2

    For the second part, you don’t need to sort the lists; use Enum. frequencies and Enum.reduce to get the multiplication of the elements.

     frequencies_second_list = Enum.frequencies(second_list)
    
    
       Enum.reduce(first_list, 0, fn elem, acc ->
         elem * Map.get(frequencies_second_list, elem, 0) + acc
       end)
    

    That’s it. As you can see, once we have a good structure, the corresponding module, in this case, Enum, makes the operations more straightforward, so it’s worth spending some time defining which input will make our life easier.

    You can see the full version of the exercise here .

    The post Advent of Code 2024 appeared first on Erlang Solutions .

    • chevron_right

      Erlang Solutions: MongooseIM 6.3: Prometheus, CockroachDB and more

      news.movim.eu / PlanetJabber • 14 November, 2024 • 9 minutes

    MongooseIM is a scalable, efficient, high-performance instant messaging server using the proven, open, and extensible XMPP protocol. With each new version, we introduce new features and improvements. For example, version 6.2.0 introduced our new CETS in-memory storage, making setup and autoscaling in cloud environments easier than before (see the blog post for details). The latest release 6.3.0 is no exception. The main highlight is the complete instrumentation rework, allowing seamless integration with modern monitoring solutions like Prometheus.

    Additionally, we have added CockroachDB to the list of supported databases, so you can now let this highly scalable database grow with your applications while avoiding being locked into your cloud provider.

    Observability and instrumentation

    In software engineering, observability is the ability to gather data from a running system to figure out what is going inside: is it working as expected? Does it have any issues? How much load is it handling, and could it do more? There are many ways to improve the observability of a system, and one of the most important is instrumentation . Just like adding extra measuring equipment to a physical system, this means adding additional code to the software. It allows the system administrator to observe the internal state of the system. This comes with a price. There is more work for the developers, increased complexity, and potential performance degradation caused by the collection and processing of additional data.

    However, the benefits usually outweigh the costs, and the ability to inspect the system is often a critical requirement. It is also worth noting that the metrics and events gathered by instrumentation can be used for further automation, e.g. for autoscaling or sending alarms to the administrator.

    Instrumentation in MongooseIM

    Even before our latest release of MongooseIM, there have been multiple means to observe its behaviour:

    Metrics provide numerical values of measured system properties. The values change over time, and the metric can present current value, sum from a sliding window, or a statistic (histogram) of values from a given time period. Prior to version 6.3, MongooseIM used to store such metrics with the help of the exometer library. To view the metrics, one had to configure an Exometer exporter, which would periodically send the metrics to an external service using the Graphite protocol. Because of the protocol, the metrics would be exported to Graphite or InfluxDB version 1 . One could also query a limited subset of metrics using our GraphQL API (or the legacy REST API) or with the command line interface. Alternatively, metrics could be retrieved from the Erlang shell of a running MongooseIM node.

    Logs are another type of instrumentation present in the code. They inform about events occurring in the system and since version 4, they are events with extensible map-like structure and can be formatted e.g. as plain text or JSON. Subsequently, they can be shown in the console or stored in files. You can also set up a log management system like the Elastic (ELK) Stack or Splunk – see the documentation for more details.

    The diagram below shows how these two types of instrumentation can work together:

    The first observation is that the instrumented code needs to separately call the log and metric API. Updating a metric and logging an event requires two distinct function calls. Moreover, if there are multiple metrics (e.g. execution time and total number of calls), there would be multiple function calls required. There is potential for inconsistency between metrics, or between metrics and logs, because an error could happen between the function calls. The main issue of this solution is however the hardcoding of Exometer as the metric library and the limitation of the Graphite protocol used to push the metrics to external services.

    Instrumentation rework in MongooseIM 6.3

    The lack of support for the modern and widespread Prometheus protocol was one of the main reasons for the complete rework of instrumentation in version 6.3. Let’s see the updated diagram of MongooseIM instrumentation:

    The most noticeable difference is that in the instrumented code, there is just one event emitted. Such an event is identified by its name and a key-value map of labels and contains measurements (with optional metadata) organised in a key-value map. Each event has to be registered before its instances are emitted with particular measurements. The point of this preliminary step is not only to ensure that all events are handled but also to provide additional information about the event, e.g. the measurement keys that will be used to update metrics. Emitted events are then handled by configurable handlers . Currently, there are three such handlers. Exometer and Logger work similarly as before, but there is a new Prometheus handler as well, which stores the metrics internally in a format compatible with Prometheus and exposes them over an HTTP API. This means that any external service can now scrape the metrics using the Prometheus protocol. The primary case would be to use Prometheus for metrics collection, and a graphical tool like Grafana for display. If you however prefer InfluxDB version 2, you can easily configure a scraper , which would periodically put new data into InfluxDB.

    As you can see in the diagram, logs can be also emitted directly, bypassing the instrumentation API. This is the case for multiple logs in the system, because often there is no need for any metrics, and a log message is enough. In the future though, we might decide to fully replace logs with instrumentation events, because they are more extensible.

    Apart from supporting the Prometheus protocol, additional benefits of the new solution include easier configuration, extensibility, and the ability to add more handlers in the future. You can also have multiple handlers enabled simultaneously, allowing you to gradually change your metric backend from Exometer to Prometheus. Conversely, you can also disable all instrumentation, which was not possible prior to version 6.3. Although it might make little sense at first glance, because it can render the system a black box, it can be useful to gain extra performance in some cases, e.g. if the external metrics like CPU usage are enough, in case of an isolated embedded system, or if resources are very limited.

    The table below compares the legacy metrics solution with the new instrumentation framework:

    Solution Legacy: mongoose_metrics New: mongoose_instrument
    Intended use Metrics Metrics, logs, distributed tracing, alarms, …
    Coupling with handlers Tight: hardcoded Exometer logic, one metric update per function call Loose: events separated from configurable handlers
    Supported handlers Exometer is hardcoded Exometer, Prometheus, Log
    Events identified by Exometer metric name (a list) Event name, Labels (key-value map)
    Event value Single-dimensional numerical value Multi-dimensional measurements with metadata
    Consistency checks None – it is up to the implementer to verify that the correct metric is created and updated Prometheus HTTP endpoint, legacy GraphQL / CLI / REST for Exometer
    API GraphQL / CLI and REST Prometheus HTTP endpoint,legacy GraphQL / CLI / REST for Exometer

    There are about 140 events in total, and some of them have multiple dimensions. You can find an overview in the documentation . In terms of dashboards for tools like Grafana, we believe that each use case of MongooseIM deserves its own. If you are interested in getting one tailored to your needs, don’t hesitate to contact us .

    Using the instrumentation

    Let’s see the new instrumentation in action now. Starting with configuration, let’s examine the new additions to the default configuration file :

    [[listen.http]]
      port = 9090
      transport.num_acceptors = 10
    
      [[listen.http.handlers.mongoose_prometheus_handler]]
        host = "_"
        path = "/metrics"
    
    (...)
    
    [instrumentation.prometheus]
    
    [instrumentation.log]
    
    

    The first section, [[listen.http]] , specifies the Prometheus HTTP endpoint. The following [instrumentation.*] sections enable the Prometheus and Log handlers with the default settings – in general, instrumentation events are logged on the DEBUG level, but you can change it. This configuration is all you need to see the metrics at http://localhost:9091/metrics when you start MongooseIM.

    As a second example, let’s say that you want only the Graphite protocol integration. In this case, you might configure MongooseIM to use only the Exometer handler, which would push the metrics prefixed with mim to the influxdb1 host every 60 seconds:

    [[instrumentation.exometer.report.graphite]]
      interval = 60_000
      prefix = "mim"
      host = "influxdb1"
    


    There are more options possible, and you can find them in the documentation .

    Tracing – ad-hoc instrumentation

    There is one more type of observability available in Erlang systems, which is tracing . It enables a user to have a more in-depth look into the Erlang processes, including the functions being called and the internal messages being exchanged. It is meant to be used by Erlang developers, and should not be used in production environments because of the impact it can have on a running system. It is good to know, however, because it could be helpful to diagnose unusual issues. To make tracing more user-friendly, MongooseIM now includes erlang_doctor with some MongooseIM-specific utilities (see the tr_util module). This tool provides low-level ad-hoc instrumentation, allowing you to instrument functions in a running system, and gather the resulting data in an in-memory table, which can be then queried, processed, and – if needed – exported to a file. Think of it as a backup solution, which could help you diagnose hidden issues, should you ever experience one.

    CockroachDB – a database that scales with MongooseIM

    MongooseIM works best when paired with a relational database like PostgreSQL or MySQL, enabling easy cluster node discovery with CETS and persistent storage for users’ accounts, archived messages and other kinds of data. Although such databases are not horizontally scalable out of the box, you can use managed solutions like Amazon Aurora , AlloyDB or Azure Cosmos DB for PostgreSQL . The downsides are the possible vendor lock-in and the fact that you cannot host and manage the DB yourself. With version 6.3 however, the possibilities are extended to CockroachDB . This PostgreSQL-compatible distributed database can be used either as a provider-independent cloud-based solution or as an internally hosted cluster. You can instantly set it up in your local environment and take advantage of the horizontal scalability of both MongooseIM and CockroachDB. If you want to learn how to deploy both MongooseIM and CockroachDB in Kubernetes, see the documentation for CockroachDB and the Helm chart for MongooseIM, together with our recent blog post about setting up an auto-scalable cluster. If you are interested in having an auto-scalable solution deployed for you, please consider our MongooseIM Autoscaler .

    Summary

    MongooseIM 6.3.0 opens new possibilities for observability – the Prometheus protocol is supported instantly with a new reworked instrumentation layer underneath, guaranteeing ease of future extensions. Regarding database integration, you can now use CockroachDB to store all your persistent data. Apart from these changes, the latest version introduces a multitude of improvements and updates – see the release notes for more information. As the next step, we recommend visiting our product page to see the possible options of support and the services we offer. You can also try the server out at trymongoose.im . In any case, should you have any further questions, feel free to contact us .

    The post MongooseIM 6.3: Prometheus, CockroachDB and more appeared first on Erlang Solutions .

    • wifi_tethering open_in_new

      This post is public

      www.erlang-solutions.com /blog/mongooseim-6-3-prometheus-cockroachdb-and-more/

    • chevron_right

      ProcessOne: Docker: set up ejabberd and keep it updated automagically with Watchtower

      news.movim.eu / PlanetJabber • 12 November, 2024 • 5 minutes

    This blog post will guide you through the process of setting up an ejabberd Community Server using Docker and Docker Compose , and will also introduce Watchtower for automatic updates. This approach ensures that your configuration remains secure and up to date.

    Furthermore, we will examine the potential risks associated with automatic updates and suggest Diun as an alternative tool for notification-based updates.

    1. Prerequisites

    Please ensure that Docker and Docker Compose are installed on your system.
    It would be beneficial to have a basic understanding of Docker concepts, including containers, volumes, and bind-mounts.

    2. Set up ejabberd in a docker container

    Let’s first create a minimal Docker Compose configuration to start an ejabberd instance.

    2.1: Prepare the directories

    For this setup, we will create a directory structure to store the configuration, database, and logs. This will assist in maintaining an organised setup, facilitating data management and backup.

    mkdir ejabberd-setup && cd ejabberd-setup
    touch docker-compose.yml
    mkdir conf
    touch conf/ejabberd.yml
    mkdir database
    mkdir logs
    

    This should give you the following structure:

    ejabberd-setup/
    ├── conf
    │   └── ejabberd.yml
    ├── database
    ├── docker-compose.yml
    └── logs
    

    To verify the structure, use the tree command. It is a very useful tool which we use on a daily basis.

    Set permissions

    Since we&aposll be using bind mounts in this example, it’s important to ensure that specific directories (like database and logs) have the correct permissions for the ejabberd user inside the container (UID 9000 , GID 9000 ).

    Customize or skip depending on your needs:

    sudo chown -R 9000:9000 database
    sudo chown -R 9000:9000 logs
    

    Based on this Issue .

    2.2: The docker-compose.yml file

    Now, create a docker-compose.yml file inside, containing:

    services:
      ejabberd:
        image: ejabberd/ecs:latest
        container_name: ejabberd
        ports:
          - "5222:5222"  # XMPP Client
          - "5280:5280"  # Web Admin Interface, optional
        volumes:
          - ./database:/home/ejabberd/database
          - ./ejabberd.yml:/home/ejabberd/conf/ejabberd.yml
          - ./logs:/home/ejabberd/logs
        restart: unless-stopped
    

    2.3: The ejabberd.yml file

    A basic configuration file for ejabberd will be required. we will name it conf/ejabberd.yml .

    loglevel: 4
    hosts:
    - "localhost"
    
    acl:
      admin:
        user:
          - "admin@localhost"
    
    access_rules:
      local:
        allow: all
    
    listen
      -
        port: 5222
        module: ejabberd_c2s
    
      -
        port: 5280                       # optional
        module: ejabberd_http            # optional
        request_handlers:                # optional
          "/admin": ejabberd_web_admin   # optional
    

    Did you know? Since 23.10 , ejabberd now offers users the option to create or update the relevant MySQL, PostgreSQL or SQLite tables automatically with each update. You can read more about it here .

    3: Starting ejabberd

    Finally, we&aposre set: you can run the following command to start your stack: docker-compose up -d

    Your ejabberd instance should now running in a Docker container! Good job! 🎉

    From there, customize ejabberd to your liking! Naturally, in this example we&aposre going to keep ejabberd in its barebones configuration, but we recommend that you configure it as you wish at this stage, to suit your needs (Domains, SSL, favorite modules, chosen database, admin accounts, etc.)

    Example: You could register your admin account at this stage

    To use the admin interface, you need to create an admin account. You can do so by running the following command:

    $ docker exec -it ejabberd bin/ejabberdctl register admin localhost very_secret_password
    > User admin@localhost successfully registered
    

    Once this step is complete, you will then be able to access the web admin interface at http://localhost:5280/admin .

    4. Set up automatic updates

    Finally, we come to the most interesting part: how do I keep my containers up to date?

    To keep your ejabberd instance up-to-date, you can use Watchtower , a Docker container that automatically updates other containers when new versions are available.

    Warning: Auto-updates are undoubtedly convenient, but they can occasionally cause issues if an update includes breaking changes. Always test updates in a staging environment and back up your data before enabling auto-updates. Further information can be found at the end of this post.

    If greater control over updates is required (for example, for mission-critical production servers or clusters), we recommend using Diun , which can notify you of available updates and allow you to decide when to apply them.

    4.1: Add Watchtower to your docker-compose.yml

    To include Watchtower , add it as a service in docker-compose.yml :

    services:
      ejabberd:
        image: ejabberd/ecs:latest
        container_name: ejabberd
        ports:
          - "5222:5222"  # XMPP Client
          - "5280:5280"  # Web Admin Interface, optional
        volumes:
          - ./database:/home/ejabberd/database
          - ./ejabberd.yml:/home/ejabberd/conf/ejabberd.yml
          - ./logs:/home/ejabberd/logs
        restart: unless-stopped
    
      watchtower:
        image: containrrr/watchtower
        container_name: watchtower
        volumes:
          - /var/run/docker.sock:/var/run/docker.sock
        environment:
          - WATCHTOWER_POLL_INTERVAL=3600 # Sets how often Watchtower checks for updates (in seconds).
          - WATCHTOWER_CLEANUP=true # Ensures old images are cleaned up after updating.
        restart: unless-stopped
    

    Watchtower offers a wide range of additional features, including the ability to set up notifications, exclude specific containers, and more. For further information, please refer to the Watchtower Docs .

    Once the docker-compose.yml has been updated, please bring it up using the following command: docker-compose up -d

    And.... here you go, you&aposre all set!

    5. Best Practices & closing words

    Now Watchtower will now perform periodic checks for updates to your ejabberd container and apply them automatically.

    Well to be fair, by default if other containers are running on the same server, Watchtower will also update them. This behaviour can be controlled with the help of environment variables (see Container Selection ), which will assist in excluding containers from updates.


    One important thing to understand is that Watchtower will only update containers tagged with the :latest tag.

    In an environment with numerous Docker containers, using the latest tag streamlines the process of automatic updates. However, it may introduce unanticipated changes with each new, disruptive update. Ideally, we recommend always setting a speficic version like ejabberd/ecs:24.10 and deciding how/when to update it manually (especially if you&aposre into infra-as-code ).

    However, we recognise that some users may prefer the convenience of automatic updates, personnally that&aposs what I do my homelab but I&aposm not scared to dig in if stuff breaks.


    tl;dr: For a small community server/homelab/personnal instance, Watchtower will help keep things up to date with minimal effort. However, for bigger production environments, it is advisable to tag specific versions to ensure greater control and resilience and update them manually.

    With this setup, you now have a fully functioning XMPP server using ejabberd, with automatic updates. You can now start building your chat applications or integrate it with your existing services! 🚀

    • wifi_tethering open_in_new

      This post is public

      www.process-one.net /blog/docker-ejabberd-watchtower/

    • chevron_right

      ProcessOne: Thoughts on Improving Messaging Protocols — Part 2, Matrix

      news.movim.eu / PlanetJabber • 5 November, 2024 • 2 minutes

    Thoughts on Improving Messaging Protocols — Part 2, Matrix

    In the first part of this blog post , I explained how the Matrix protocol works, contrasted its design philosophy with XMPP, and discussed why these differences lead to performance costs in Matrix. Matrix processes each conversation as a graph of events, merged in real-time [1] .

    Merge operations can be costly in Matrix for large rooms, affecting both database storage and load and disk usage when memory is exhausted, reaching swap level .

    That said, there is still room for improvement in the protocol. We have designed and tested slight changes that could make Matrix much more efficient for large rooms.

    A Proposal to Simplify and Speed Up Merge Operations

    Here is the rationale behind a proposal we have made to simplify and speed up merge operations:

    State resolution v2 uses certain graph algorithms, which can result in at least linear processing time for the number of state events in a room’s DAG, creating a significant load on servers.

    The goal of this issue is to discuss and develop changes to state resolution to achieve O(n log ⁡ n) total processing time when handling a room with n state events (i.e., O(log ⁡ n) on average) in realistic scenarios, while maintaining a good user experience.

    The approach described below is closer to state resolution v1 but seeks to address state resets in a different way.

    For more detail, you can read our proposal on the Matrix spec tracker: Make state resolution faster .

    In simpler terms, we propose adding a version associated with each event_id to simplify conflict management and introduce a heuristic that skips traversal of large parts of the graph.

    Impact of the Proposal

    From our initial assessment, in a very large room — such as one with 100,000 members — our approach could improve processing performance by 100x to 1000x, as the current processing cost scales with the number of users in the room. This improvement would enable smoother conversations, reduced lag, and more responsive interactions for end-users, while also reducing server infrastructure load and resource usage.

    While our primary goal is to improve performance in very large rooms, these changes benefit all users by reducing overall server load and improving processing times across various room sizes.

    We plan to implement this improvement in our own code to evaluate its real-world effectiveness while the Matrix team considers its potential value for the reference protocol.


    1. For those who remember, a conversation in Matrix is similar to the collaborative editing protocol built on top of XMPP for the Google Wave platform.
    • wifi_tethering open_in_new

      This post is public

      www.process-one.net /blog/thoughts-on-improving-messaging-protocols-part-2-matrix/

    • chevron_right

      Ignite Realtime Blog: Openfire 4.9.1 release

      news.movim.eu / PlanetJabber • 1 November, 2024 • 1 minute

    The Ignite Realtime community is happy to be able to announce the immediate availability of version 4.9.1 of Openfire , its cross-platform real-time collaboration server based on the XMPP protocol!

    4.9.1 is a bugfix and maintenance release. Among its most important fixes is one for a memory leak that affected all recent versions of Openfire (but was likely noticeable only on those servers that see high volume of users logging in and out). The complete list of changes that have gone into this release can be seen in the change log .

    Please give this version a try! You can download installers of Openfire here . Our documentation contains an upgrade guide that helps you update from an older version.

    The integrity of these artifacts can be checked with the following sha256sum values:

    8c489503f24e35003e2930873037950a4a08bc276be1338b6a0928db0f0eb37d  openfire-4.9.1-1.noarch.rpm
    1e80a119c4e1d0b57d79aa83cbdbccf138a1dc8a4086ac10ae851dec4f78742d  openfire_4.9.1_all.deb
    69a946dacd5e4f515aa4d935c05978b5a60279119379bcfe0df477023e7a6f05  openfire_4_9_1.dmg
    c4d7b15ab6814086ce5e8a1d6b243a442b8743a21282a1a4c5b7d615f9e52638  openfire_4_9_1.exe
    d9f0dd50600ee726802bba8bc8415bf9f0f427be54933e6c987cef7cca012bb4  openfire_4_9_1.tar.gz
    de45aaf1ad01235f2b812db5127af7d3dc4bc63984a9e4852f1f3d5332df7659  openfire_4_9_1_x64.exe
    89b61cbdab265981fad4ab4562066222a2c3a9a68f83b6597ab2cb5609b2b1d7  openfire_4_9_1.zip
    

    We would love to hear from you! If you have any questions, please stop by our community forum or our live groupchat . We are always looking for volunteers interested in helping out with Openfire development!

    For other release announcements and news follow us on Mastodon or X

    1 post - 1 participant

    Read full topic